Editando um parâmetro

Editar online

Os parâmetros definem elementos de variável de um caminho de URL, parâmetros de consulta, cabeçalhos ou corpo da solicitação. É possível editar parâmetros que foram criados anteriormente para a API ou para operações Caminhos e Caminho em sua definição de API.

Antes de Iniciar

Abra o formulário de detalhes para um parâmetro. Para obter detalhes das áreas em sua definição de API de onde é possível editar um parâmetro, veja os tópicos a seguir:

Sobre essa tarefa

Nota: esta tarefa está relacionada à configuração de uma definição de API do OpenAPI 2.0 Para obter detalhes sobre como configurar uma definição de API OpenAPI 3.0 , consulte Editando uma definição de API OpenAPI 3.0.

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

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.

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. Forneça as informações a seguir:
    • Descrição: uma descrição do parâmetro Você pode usar a sintaxe CommonMark para representação em rich text.
    • Tipo: o tipo de dados do parâmetro.
    • Formato: Selecione o formato de dados; as opções disponíveis dependem do Tiposelecionado..
    • Selecione as opções a seguir conforme necessário:
      • Necessário: determina se este parâmetro é obrigatório. Se a propriedade Localizado em estiver configurada como caminho, essa opção deverá ser selecionada.
      • Permitir Valor Vazio: Permite enviar um parâmetro com um valor vazio. É válido somente se a propriedade Localizado em estiver configurada como consulta.
  2. Clique em Salvar quando concluído.

O quê fazer em seguida

Se necessário, use a trilha de navegação para navegar para outro local na hierarquia do objeto no qual você está trabalhando.