API Docs

Em API Docs você gerencia as documentações técnicas da sua API, que fica disponível em Products.

Veja como:

  • Adicionar a documentação manualmente.

    O upload manual é opcional, já que a documentação é carregada automaticamente no momento que a API é importada.

  • Editar e excluir (apenas quando a documentação tiver sido adicionada manualmente).

  • Realizar chamada de teste para a API (tryout) diretamente da documentação.

  • Configurar papéis (roles) para acesso à documentação da API.

Lista de API Docs

A lista de API Docs exibe:

  • Provider: indicado pelo logotipo do provedor do gateway.

  • Connection name: nome da conexão, tal como cadastrada na página Conexões.

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

  • Version: versão da API.

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

  • Availability: informa se a API está disponível para ser exibida no navegador e/ou para ser usada por uma APP.

    • ícone com um check a API está disponível para exibição no catálogo e para criação de apps;

    • ícone amarelo com a letra i a API não está disponível para exibição no catálogo ou (ou exclusivo) para criação de apps;

    • ícone vermelho com a letra i a API não está disponível para exibição no catálogo e (conjunção) para criação de apps.

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

    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.

screenshot da tela api docs

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.

passos para adicionar nova documentação manualmente

Como resultado desses passos, a documentação será adicionada e estará disponível na lista de API Docs.

Editando uma documentação

Apenas documentações que foram adicionadas manualmente podem ser editadas.

Para alterar uma documentação, basta substituir o arquivo. Siga os passos a abaixo:

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

  2. Na tela seguinte, role a tela para baixo até o fim e 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.

Deletando uma documentação

Apenas documentações que foram adicionadas manualmente podem ser deletadas.

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

  1. Em API DOCS, clique no ícone ícone em forma de uma lixeira.

  2. Na tela seguinte, clique no botão DELETE para confirmar a exclusão.

Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]