Depois de enviar com êxito um pedido de API, o Apidog pode analisar automaticamente os dados do pedido e da resposta para criar uma especificação completa do endpoint. Esta funcionalidade poderosa poupa tempo e garante que a sua documentação de API reflete com precisão o comportamento real.Analisar o Pedido numa Especificação de Endpoint#
Um pedido enviado com êxito, caso ainda não esteja definido, pode ser automaticamente analisado pelo Apidog numa especificação de endpoint.Depois de enviar o pedido, pode clicar no menu suspenso junto ao botão Save e selecionar Save as endpoint para o guardar como uma especificação de endpoint.Quando guarda um pedido como endpoint, o Apidog extrai de forma inteligente as seguintes informações:Parâmetros do Pedido: Os tipos de parâmetros do pedido atual serão tratados como a especificação dos parâmetros do pedido no endpoint, e os valores atuais dos parâmetros serão considerados valores de exemplo para os parâmetros do pedido.
Esquema da Resposta: A estrutura de dados da resposta do pedido atual será analisada como a especificação da resposta, e os valores da resposta serão tratados como um exemplo de resposta.
Esta funcionalidade é particularmente útil ao trabalhar com APIs existentes ou quando pretende documentar rapidamente uma API com base em dados reais de pedido/resposta, em vez de definir manualmente o esquema.
Extrair respostas como esquemas é útil quando a estrutura da API foi alterada, enquanto extrair como exemplos é mais adequado para documentar diferentes cenários de resposta (sucesso, erros, casos limite).
