A documentação de API publicada da Apidog fornece uma vista interativa e abrangente das suas APIs. Quando os utilizadores acedem ao URL da sua documentação, verão uma apresentação bem estruturada de cada endpoint, com várias secções concebidas para facilitar a compreensão e o teste.
Esta secção apresenta informações essenciais do endpoint, tais como o URL, o método HTTP, a hora de modificação e a descrição. Pode escolher quais os campos a apresentar ao criar a documentação.
Os endpoints com o estado "Released" não apresentarão uma etiqueta de estado. Os endpoints com outros estados (como "Developing") apresentarão uma etiqueta de estado após o nome do endpoint. Os endpoints com o estado "Deprecated" aparecem como "nome do endpoint" na árvore de diretórios à esquerda.
Clique em "Experimente" para expandir a camada de teste interativo, onde pode enviar pedidos, modificar parâmetros e alternar entre ambientes. Os ambientes disponíveis são os que foram selecionados ao criar a documentação.
Ambiente de Cloud Mock
Se selecionar o ambiente Cloud mock ao criar a documentação, estará a fornecer aos leitores um ambiente sandbox simples para testar APIs.
Depois de enviar o pedido, pode ver a resposta e o pedido real na página.
Pode configurar a autenticação ao nível da API ou da pasta nas definições de Auth do seu projeto. Utilize security schemes ou defina as definições manualmente.
Depois de configurar as definições de autenticação — por exemplo, utilizando autenticação Bearer Token — verá uma secção "Credentials" na parte superior do painel "Publish Documentation", onde pode introduzir diretamente o valor do token.
A principal vantagem desta abordagem de configuração é que as informações de autenticação podem ser partilhadas entre diferentes APIs. Se várias APIs referenciarem o mesmo esquema de segurança ou tipo de autenticação, só precisa de introduzir as informações de autenticação uma vez, e as outras APIs podem reutilizá-las automaticamente.
Estas credenciais são encriptadas e armazenadas no LocalStorage do navegador, e são geridas com base na sessão do navegador. Dentro da mesma sessão, podem ser partilhadas entre várias janelas e separadores. Assim que o navegador é fechado e a sessão termina, estas credenciais tornam-se automaticamente inválidas.Mais especificamente: as credenciais armazenadas no LocalStorage são encriptadas, enquanto a chave de desencriptação é armazenada num cookie de sessão. Embora os dados no LocalStorage persistam a longo prazo, a chave de desencriptação no cookie de sessão expira assim que o navegador é fechado. Como resultado, os dados encriptados deixam de poder ser desencriptados ou acedidos, e terá de introduzir novamente as credenciais da próxima vez que visitar.
Esta secção apresenta as especificações de parâmetros e corpo. A Apidog suporta dois estilos de apresentação de parâmetros — Modern ou Classic — que pode escolher em Settings → Feature Settings → Endpoint Feature Settings.
Se tiver selecionado "Allow exporting data" ao criar a documentação, os leitores verão uma opção Export no canto inferior direito e no final do documento.
Os leitores podem escolher entre "Clone" ou "Export". "Export" suporta a exportação nos formatos OAS, HTML, Markdown e Apidog.
