A documentação de API publicada pelo Apidog fornece uma visualização interativa e abrangente das suas APIs. Quando os usuários acessarem a URL da sua documentação, verão uma apresentação bem estruturada de cada endpoint, com várias seções projetadas para facilitar a compreensão e os testes.
Esta seção exibe informações essenciais do endpoint, como URL, método HTTP, horário de modificação e descrição. Você pode escolher quais campos exibir ao criar a documentação.
Endpoints com status "Released" não mostrarão uma tag de status. Endpoints com outros status (como "Developing") exibirão uma tag de status após o nome do endpoint. Endpoints com status "Deprecated" aparecem como "nome do endpoint" na árvore de diretórios à esquerda.
Clique em "Experimente" para expandir a camada de teste interativo, onde você pode enviar requisições, modificar parâmetros e alternar ambientes. Os ambientes disponíveis são aqueles selecionados ao criar a documentação.
Ambiente de mock em nuvem
Se você selecionar o ambiente Cloud mock ao criar a documentação, estará fornecendo aos leitores um ambiente sandbox simples para testar APIs.
Após enviar a requisição, você pode ver a resposta e a requisição real na página.
Você pode configurar a autenticação no nível da API ou da pasta nas configurações de Auth do seu projeto. Use security schemes ou defina as configurações manualmente.
Depois de configurar as definições de autenticação — por exemplo, usando autenticação Bearer Token — você verá uma seção "Credentials" na parte superior do painel "Publish Documentation", onde poderá inserir diretamente o valor do token.
O principal benefício dessa abordagem de configuração é que as informações de autenticação podem ser compartilhadas entre diferentes APIs. Se várias APIs fizerem referência ao mesmo security scheme ou tipo de autenticação, você só precisará inserir as informações de autenticação uma vez, e outras APIs poderão reutilizá-las automaticamente.
Essas credenciais são criptografadas e armazenadas no LocalStorage do navegador, e são gerenciadas com base na sessão do navegador. Dentro da mesma sessão, elas podem ser compartilhadas entre várias janelas e abas. Quando o navegador é fechado e a sessão termina, essas credenciais tornam-se automaticamente inválidas.Mais especificamente: as credenciais armazenadas no LocalStorage são criptografadas, enquanto a chave de descriptografia é armazenada em um cookie de sessão. Embora os dados no LocalStorage persistam em longo prazo, a chave de descriptografia no cookie de sessão expira assim que o navegador é fechado. Como resultado, os dados criptografados não podem mais ser descriptografados nem acessados, e você precisará inserir as credenciais novamente na próxima vez que visitar a página.
Esta seção exibe as especificações de parâmetros e corpo. O Apidog oferece suporte a dois estilos de exibição de parâmetros — Modern ou Classic — que você pode escolher em Settings → Feature Settings → Endpoint Feature Settings.
Se você selecionou "Allow exporting data" ao criar a documentação, os leitores verão uma opção Export no canto inferior direito e na parte inferior do documento.
Os leitores podem escolher entre "Clone" ou "Export". "Export" oferece suporte à exportação nos formatos OAS, HTML, Markdown e Apidog.
