Catálogo

Visão Geral

O catálogo contempla a lista de APIs e integrações que tiveram suas documentações publicadas no portal. Todas as documentações publicadas se tornam acessíveis aos usuários do portal. Para saber mais sobre a visualização do catálogo no portal, acesse as seções Catálogo de APIs e Catálogo de Serviços do Dev Portal.

Informação adicional

A documentação da API é composta da sua especificação, em formato OpenAPI ou Swagger e, opcionalmente, uma documentação complementar em formato Markdown. Para saber mais sobre o processo de publicação de APIs no portal, acesse a seção Publicação Dev Portal da API.

A documentação de um serviço de integração é composto de uma documentação em formato Markdown. Para saber mais sobre o processo de publicação de integrações no portal, acesse a seção Publicação Dev Portal da integração.

Visualização

O processo de publicação de documentações no portal é realizado nas interfaces de configuração de APIs e integrações. A relação das documentações publicações é unificada no estúdio do portal. A partir da home, acesse o ícone de configurações da Organização ⚙ menu > Portais. Na página de portais, visualize o portal desejado e acesse o menu > Catálogo. O catálogo é dividido em duas categorias:

• APIs: relação de nome e versão da API, workspace pertencente e as versões da especificação e documentação publicadas.
• Integrações: relação de nome e versão da integração, workspace pertencente e a versão da documentação publicada.