Os Testes de Contrato são utilizados para validar se a resposta real da API está em conformidade com a especificação definida na documentação da API (OpenAPI). Ao efetuar verificações de consistência em conteúdos como o código de estado e a estrutura da resposta, permite descobrir atempadamente inconsistências entre a implementação e a documentação durante as fases de desenvolvimento, depuração e teste, garantindo um comportamento da API estável e fiável entre serviços.A capacidade de Validação da Resposta (Teste de Contrato) do Apidog está profundamente integrada com a documentação da API. Pode ser utilizada durante Pedidos de API, em Casos de Depuração, Casos de Teste e Passos de Teste de Automação. É uma funcionalidade fundamental que está ativada por predefinição.Ativar a Validação da Resposta#
A Validação da Resposta pode ser ativada por módulo e utilizada em diferentes fases com base nas necessidades do negócio. O seletor relevante está localizado em "Settings -> Response Validation Settings".Pedidos de API e Casos de Depuração#
Quando ativada, a funcionalidade "Validate Response" está disponível nas vistas "Request" e "Debug Case" no módulo APIs, sendo utilizada para verificar a consistência da resposta durante a fase de depuração.Casos de Teste#
Quando ativada, a opção "Validate Response" pode ser executada em "Test Cases" no módulo APIs para verificar o comportamento da API durante testes manuais.Passos de Teste de Automação#
Quando ativada, a opção "Validate Response" pode ser adicionada como um Passo de Teste no módulo Tests, incorporando a Validação da Resposta no fluxo de trabalho completo de testes automatizados.Validar o Conteúdo da Resposta#
A Validação da Resposta do Apidog efetuará automaticamente as seguintes verificações com base na especificação OpenAPI definida na documentação da API:Validar o Código de Estado HTTP da Resposta#
Verifica se o código de estado HTTP da resposta real é consistente com o código de estado 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 dentro do intervalo permitido
Validar o 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 enum são válidos
Controlo de Propriedades Adicionais em Objetos#
Para campos do tipo Object:Se additionalProperties não estiver definido na documentação, pode escolher se pretende permitir que a resposta real contenha campos extra não definidos na documentação.
Se additionalProperties estiver definido, valida a permissão de campos extra de acordo com as regras da documentação.
Modified at 2026-06-09 08:54:45
