O Teste de Contrato é usado para validar se a resposta real da API está em conformidade com a especificação definida na documentação da API (OpenAPI). Ao realizar verificações de consistência em conteúdos como o código de status e a estrutura da resposta, ele permite descobrir, em tempo hábil, inconsistências entre a implementação e a documentação durante as fases de desenvolvimento, depuração e teste, garantindo um comportamento de API estável e confiável entre serviços.A capacidade de Validação de Resposta (Teste de Contrato) do Apidog é profundamente integrada à documentação da API. Ela pode ser usada durante Requisições de API, em Casos de Depuração, Casos de Teste e Etapas de Teste de Automação. É um recurso fundamental habilitado por padrão.Habilitar Validação de Resposta#
A Validação de Resposta pode ser habilitada por módulo e usada em diferentes estágios com base nas necessidades de negócios. O botão de alternância relevante está localizado em "Configurações -> Configurações de Validação de Resposta".Requisições de API e Casos de Depuração#
Quando habilitado, o recurso "Validar Resposta" fica disponível nas visualizações "Requisição" e "Caso de Depuração" dentro do módulo de APIs, usado para verificar a consistência da resposta durante a fase de depuração.Casos de Teste#
Quando habilitado, "Validar Resposta" pode ser executado em "Casos de Teste" dentro do módulo de APIs para verificar o comportamento da API durante testes manuais.Etapas de Teste de Automação#
Quando habilitado, "Validar Resposta" pode ser adicionado como uma Etapa de Teste no módulo de Testes, incorporando a Validação de Resposta ao fluxo de trabalho completo de testes automatizados.Validar Conteúdo da Resposta#
A Validação de Resposta do Apidog realizará automaticamente as seguintes verificações com base na especificação OpenAPI definida na documentação da API:Validar Código de Status HTTP da Resposta#
Verifica se o código de status HTTP da resposta real é consistente com o código de status definido na documentação. Por exemplo:A documentação define 200, mas o retorno real é 204
A documentação define vários valores possíveis (por exemplo, 200, 201, 400, 403), validando em relação ao intervalo permitido
Validar Schema do Corpo da Resposta#
Valida o seguinte conteúdo com base no Schema de Dados definido na documentação:Se um campo é obrigatório
Se o valor de um campo é null
Se o tipo do campo está correto
Se os campos obrigatórios estão presentes
Se a estrutura de Arrays e Objects está em conformidade com a documentação
Se os valores de enum são válidos
Controle de Propriedades Adicionais em Objetos#
Para campos do tipo Object:Se additionalProperties não estiver definido na documentação, você poderá escolher se permite que a resposta real contenha campos extras não definidos na documentação.
Se additionalProperties estiver definido, ele valida a permissão de campos extras de acordo com as regras da documentação.
Modified at 2026-06-11 10:21:25
