Definindo componentes de parâmetros

Editar online

Os componentes do parâmetro definem parâmetros reutilizáveis que podem especificar elementos de variáveis de um caminho de URL, parâmetros de consulta, cabeçalhos ou um corpo de solicitação.

Sobre essa tarefa

Nota:
  • Esta tarefa está relacionada com a configuração de uma definição de API OpenAPI 3.0. Para obter detalhes sobre como configurar uma definição de API OpenAPI 2.0 , consulte Editando uma definição de API OpenAPI 2.0.
  • OpenAPI 3.0 APIs são suportadas apenas com o DataPower® API Gateway, não com o DataPower Gateway (v5 compatible).
  • Para obter detalhes das limitações de suporte atuais do OpenAPI 3.0 , consulte OpenAPI 3.0 suporte no IBM® API Connect.

É possível concluir essa tarefa usando o aplicativo da UI do API Designer ou usando a UI do API Manager baseado em navegador.

Para fazer uso de um componente de parâmetro, deve-se referenciá-lo de outro lugar em sua definição de API.

Um parâmetro é semelhante a um cabeçalho com as diferenças a seguir:
  • Parâmetros transportam dados reais e ficam disponíveis para os usuários finais. Cabeçalhos transportam metadados associados a uma solicitação ou resposta e ficam ocultos para os usuários.
  • Um parâmetro pode ter vários locais e o local de um cabeçalho é sempre configurado como header.
  • Um parâmetro pode ter vários estilos de formato; o estilo de um cabeçalho é sempre simple.
Para obter mais informações sobre cabeçalhos, consulte Criando um Cabeçalho

A qualquer momento, você pode acessar diretamente o arquivo YAML de origem do ` OpenAPI ` clicando no ícone "Fonte Ícone de origem OpenAPI". Para voltar ao formulário de criação, clique no ícone Ícone de formulárioFormulário.

Procedimento

  1. Abra a API para edição, conforme descrito em Editando uma definição de API do OpenAPI 3.0 ..
  2. Expandir Componentes , se já houver um ou mais componentes de parâmetro definidos, expanda Parâmetros.
  3. É possível criar um novo componente de parâmetro ou editar qualquer componente de parâmetro existente.
    • Para criar um componente de parâmetro, clique no ícone de adição Ícone de inclusão da API OpenAPI 3.0 ao lado de Parâmetros e, em seguida, consulte a seção Criação de um parâmetro.
    • Para editar um componente de parâmetro existente, clique no nome do componente de parâmetro no painel de navegação e, em seguida, consulte a seção “Editando um parâmetro ”.