API Docs

API Docs gerencia as documentações técnicas das suas APIs, que estarão disponíveis em Products.

A documentação é carregada automaticamente no momento da importação da API, mas você também pode adicioná-la manualmente.

Também é possível editar e excluir (quando a documentação tiver sido adicionada manualmente) e visualizar.

Lista de API Docs

A lista de API Docs exibe:

  • Type: a documentação pode ser do tipo Swagger 3.0 ou OpenAPI 3.0;

  • API Name: nome da API, tal como cadastrada na plataforma;

  • Version: versão da API;

  • Last revision: última revisão da API;

  • Source: origem da documentação (API Plataform ou upload manual);

  • Actions: a partir desta coluna, você pode editar, deletar e visualizar uma documentação, clicando no ícone respectivo.

tela com lista de API Docs

Os ícones de ação para editar (ícone com imagem de um lápis) e deletar (ícone com a imagem de uma lixeira) não estão disponíveis para documentação que foi adicionada automaticamente com a importação da API.

Localizando uma documentação

O campo de busca está localizado logo acima da lista de API Docs.

Você pode buscar pela documentação por nome da API e ordenar o resultado por ordem crescente ou decrescente.

Upload manual

Para adicionar uma documentação manualmente, siga os passos abaixo:

  1. Em API Docs, clique no botão NEW API DOCS.

  2. Na tela seguinte, clique em UPLOAD YOUR FILE, localizado na parte inferior esquerda da tela.

  3. Navegue pelo seu gerenciador de arquivos e selecione o arquivo .yaml ou .json desejado.
    Você pode carregar um arquivo por vez.

  4. O arquivo selecionado será exibido na tela. Clique em SAVE para salvar ou REPLACE FILE para escolher outro arquivo.

Visualizando uma documentação

Para verificar se a sua documentação está de acordo com a API importada, siga os passos abaixo:

  1. Em API DOCS, clique no ícone icone em forma de um olho.

  2. A tela seguinte exibirá a última versão do Swagger ou OpenAPI. Caso existam versões anteriores, elas estarão listadas na parte superior da tela. Selecione a versão que deseja visualizar.

Como resultado desses passos, a documentação será carregada e exibida na tela. Uma vez carregada, a coluna TYPE, da listagem de API Docs, passa a indicar o tipo daquela documentação, sendo:

  • icone com imagem de uma prancheta de contorno azul OpenApi e

  • icone com imagem três pontos entre chaves Swagger.

Editando uma documentação

Para alterar uma documentação, siga os passos a abaixo:

  1. Em API DOCS, clique em ícone em forma de um lápis.

  2. Na tela seguinte, clique no botão REPLACE FILE.

  3. Navegue pelo seu gerenciador de arquivos e selecione o arquivo .yaml ou .json desejado.
    Você pode carregar um arquivo por vez.

  4. Clique no botão SAVE para salvar ou SAVE AS NEW VERSION para salvar como nova versão.

Thanks for your feedback!
EDIT
How useful was this article to you?