Incluindo tags em uma API

Editar online

É possível incluir tags na definição de API. Essas tags são incluídas na definição de OpenAPI da API, mas não são usadas pelo API Connect para qualquer indexaçã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.

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 o Geral , se já houver uma ou mais tags definidas, expanda Tags.
Para adicionar uma nova tag, clique no ícone de adição ao lado de “Tags” no painel de navegação. Para editar uma tag existente, clique no nome da tag na área de janela de navegação.
Forneça as informações a seguir:
- Nome (obrigatório): o nome da tag.
- Descrição: uma descrição opcional da tag. Você pode usar a sintaxe CommonMark para representação em rich text.
- External Documentation > URL (disponível ao editar uma tag existente): O endereço URL para a documentação de destino que descreve essa tag.
- Documentação externa > Descrição (disponível ao editar uma tag existente): Uma descrição opcional da documentação de destino.
Se estiver criando uma nova tag, clique em Criar.
Os detalhes da tag são exibidos para edição adicional, conforme descrito na etapa 4
Clique em Salvar quando concluído.