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 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.
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 da resposta: Um nome para a resposta.
Se você estiver editando uma resposta de operação, esse nome será o código de status HTTP.
Se você estiver editando um componente de resposta, esse nome definirá uma chave que possibilitará que essa resposta seja referenciada de outro lugar na definição da API. A referência terá o formato a seguir:
#/components/responses/Name
Para alterar o nome, clique em Atualizare, em seguida, clique em Salvar quando concluído.
- Descrição: uma descrição da resposta Você pode usar a sintaxe CommonMark para representação em rich text.
- Cabeçalhos: os cabeçalhos definem informações que podem ser retornadas na resposta.
Para definir um novo cabeçalho para a resposta, clique em Adicionar e, em seguida, consulte a seção “Criação de um cabeçalho ”.
Para editar um cabeçalho existente, clique no nome do cabeçalho e consulte a seção “Editando um cabeçalho ”.
- Conteúdo: uma definição de conteúdo descreve o conteúdo da resposta.
Para definir uma nova definição de conteúdo para a resposta, clique em Adicionar e, em seguida, consulte a seção “Criação de uma definição de conteúdo ”.
Para editar uma definição de conteúdo existente, clique no nome da definição de conteúdo e consulte a seção “Editando uma definição de conteúdo ”.
- Links: links descrevem como vários valores retornados por uma operação podem ser usados como entrada para outras operações.
Para definir um novo link para a resposta, clique em Adicionar e, em seguida, consulte a seção “Criação de um link ”.
Para editar um link existente, clique no nome do link e consulte a seção “Editando um link ”.
- 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.