Após enviar uma requisição de API com sucesso, o Apidog pode analisar automaticamente os dados da requisição e da resposta para criar uma especificação completa do endpoint. Este recurso avançado economiza tempo e garante que sua documentação de API reflita com precisão o comportamento real.Analisando a Requisição em uma Especificação de Endpoint#
Uma requisição enviada com sucesso, se ainda não estiver definida, pode ser analisada automaticamente pelo Apidog em uma especificação de endpoint.Após enviar a requisição, você pode clicar no menu suspenso ao lado do botão Save e selecionar Save as endpoint para salvá-la como uma especificação de endpoint.Ao salvar uma requisição como um endpoint, o Apidog extrai de forma inteligente as seguintes informações:Parâmetros da Requisição: Os tipos de parâmetros da requisição atual serão tratados como a especificação de parâmetros da requisição no endpoint, e os valores atuais dos parâmetros serão considerados valores de exemplo para os parâmetros da requisição.
Esquema da Resposta: A estrutura de dados da resposta da requisição atual será analisada como a especificação da resposta, e os valores da resposta serão tratados como um exemplo de resposta.
Este recurso é particularmente útil ao trabalhar com APIs existentes ou quando você deseja documentar rapidamente uma API com base em dados reais de requisição/resposta, em vez de definir manualmente o esquema.
Extrair respostas como esquemas é útil quando a estrutura da API foi alterada, enquanto extrair como exemplos é melhor para documentar diferentes cenários de resposta (sucesso, erros, casos extremos).
