Swagger
- Paulo Henrique Paixão
- Catarine Maltauro da Silva
Em manuais de API, podemos incluir o Swagger para que os usuários possam testar os Endpoints.
Neste artigo
Como funciona
Quando utilizar este componente
Este componente visa realizar a inclusão do Swagger dentro de páginas de documentação de API, desta forma, recomendamos a utilização em páginas onde o usuário pode realizar o teste dos Endpoints.
Requisito para instalação
Configurar a inclusão de conteúdo como Display all included content |
Adicionar os scripts no Help Center |
Pelo menos o idioma português deve estar ativo no documento de API |
Antes de realizar a instalação, verifique se a API existe na lista abaixo.
Se a API não estiver na lista, solicite a um dos Administradores Paulo Paixão, Catarine Maltauro para adicionar, enviando as seguintes informações:
Produto que a API pertence
URL da página no Help Center que o Swagger será incluído
URL do Swagger disponibilizada pelo desenvolvimento
Produto | Página | URL do Swagger |
|---|---|---|
NDD Orbix | api-impressoras | https://developer.nddorbix.com/printer-external-integration-api/index.html |
NDD Orbix | api-estruturacao-organizacional-do-provedor | https://developer.nddorbix.com/core-external-integration-api/index.html |
NDD Orbix | api-de-produtos | https://developer.nddorbix.com/stock-external-integration-api/index.html |
NDD Move | apis-de-integracao-nddmove | |
NDD Averba | manual-nddaverba-apis-de-integracao |
Instalação
Após atender ao requisito, basta realizar a inclusão da página component-swagger às páginas que deseja que o Componente fique disponível:
Encontrou algum problema? Procure os administradores Catarine Maltauro da Silva ou Paulo Henrique Paixão para ajustes.