Catálogo de APIs

Visão Geral

O catálogo de APIs contempla a documentação das APIs publicadas pela interface de gerenciamento de APIs e integrações (Manager) no portal. A documentação da API é composta da sua especificação, em formato OpenAPI ou Swagger e, opcionalmente, uma documentação complementar em formato Markdown.

Atenção!

É necessário ter ao menos uma API publicada no portal para que a página do catálogo de APIs esteja visível.

Para saber mais sobre o catálogo do Dev Portal, acesse a seção Catálogo da Administração do Dev Portal.

Para saber mais sobre o processo de publicação de APIs no portal, acesse a seção Publicação Dev Portal da API.

Uso

Na página inicial do catálogo, é possível filtrar as APIs realizando a busca por nome da API. Ao acessar a API escolhida é apresentado a especificação da API e a documentação Markdown, caso exista.

Caso mais de uma versão de API esteja com documentações publicadas no portal, é possível navegar entre as versões pelo menu de versões para visualizar as documentações correspondentes.

Informação adicional

Caso o provedor da API tenha cadastrado os endereços de acesso da API na especificação, é possível efetuar chamadas para a API diretamente pela interface da especificação. Essa opção é disponível no botão Try it out, localizado nos detalhes de cada rota da API.

Para saber mais sobre como disponibilizar os endereços de acesso da API na especificação, acesse a seção API Spec Design da API.