Especificando documentação externa para uma operação

É possível referenciar um recurso externo para documentação estendida para uma operação de API.

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 Ícone de origem OpenAPI ". Para voltar ao formulário de criação, clique no ícone Ícone de formulário Formulário.

Procedimento

Abra a API para edição, conforme descrito em Editando uma definição de API do OpenAPI 3.0 ..
Expandir Caminhos, em seguida, expandir o Caminho necessário.
Expandir Operações, expandir a operação necessária, em seguida, clicar em Documentação Externa.
Forneça as informações a seguir:
- URL (necessário): a URL para a documentação de destino.
- Descrição: uma descrição opcional da documentação de destino. Você pode usar a sintaxe CommonMark para representação em rich text.
Clique em Salvar quando concluído.