As respostas definem o código de status HTTP e os dados retornados em um corpo de resposta e nos cabeçalhos. É possível editar respostas que foram criadas anteriormente para operações do caminho em sua definição de API.
Antes de Iniciar
Abra o formulário de detalhes para uma resposta. Para obter detalhes das áreas em sua definição de API de onde é possível editar uma resposta, 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.
A qualquer momento, você pode acessar diretamente o arquivo YAML de origem do ` OpenAPI ` clicando no ícone "Fonte
". Para voltar ao formulário de criação, clique no ícone
Formulário.
Procedimento
- Forneça as informações a seguir:
- Nome : O código de status HTTP.
- Descrição (obrigatório): uma descrição da resposta
- Esquema: O esquema define a estrutura de resposta
Para definir um esquema para a resposta, clique em Criar e, em seguida, consulte a seção “Criação de definições de esquema ”.
Se a resposta já possuir um esquema definido, clique em Visualizar para editar o esquema
Para obter todos os detalhes sobre como editar um esquema, consulte Edição de definições de esquema.
- 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.