Contract Testing is used to validate whether the actual API response conforms to the specification defined in the API documentation (OpenAPI). By performing consistency checks on content such as the status code and response structure, it allows for the timely discovery of inconsistencies between the implementation and the documentation during the development, debugging, and testing phases, ensuring stable and reliable API behavior between services.Apidog's Response Validation (Contract Test) capability is deeply integrated with the API documentation. It can be used during API Requests, in Debug Cases, Test Cases, and Automation Test Steps. It is a foundational feature that is enabled by default.Enable Response Validation#
Response Validation can be enabled by module and used at different stages based on business needs. The relevant toggle is located in "Settings -> Response Validation Settings".API Requests and Debug Cases#
When enabled, the "Validate Response" feature is available in the "Request" and "Debug Case" views within the APIs module, used for verifying response consistency during the debugging phase.Test Cases#
When enabled, "Validate Response" can be executed in "Test Cases" within the APIs module to verify API behavior during manual testing.Automation Test Steps#
When enabled, "Validate Response" can be added as a Test Step in the Tests module, incorporating Response Validation into the complete automated testing workflow.Validate Response Content#
Apidog's Response Validation will automatically perform the following checks based on the OpenAPI specification defined in the API documentation:Validate HTTP Status Code of Response#
Checks whether the HTTP status code of the actual response is consistent with the status code defined in the documentation. For example:Documentation defines 200, but the actual return is 204
Documentation defines multiple possible values (e.g., 200, 201, 400, 403), validating against the allowed range
Validate Schema of Response Body#
Validates the following content based on the Data Schema defined in the documentation:Whether a field is required
Whether a field's value is null
Whether the field type is correct
Whether required fields are present
Whether the structure of Arrays and Objects conforms to the documentation
Whether enum values are valid
Control of Additional Properties in Objects#
If additionalProperties is not set in the documentation, you can choose whether to allow the actual response to contain extra fields not defined in the documentation.
If additionalProperties is set, it validates the allowance of extra fields according to the documentation's rules.
Modified atΒ 2025-11-18 09:58:26
