Apidog에서는 엔드포인트 내에서 요청을 보낸 후, Apidog가 엔드포인트의 사양을 기준으로 응답이 스키마를 준수하는지 자동으로 검증합니다.검증 규칙#
검증 범위#
데이터 형식: 반환된 콘텐츠의 형식입니다(JSON, XML, HTML, Raw, Binary, No-Content, MsgPack, Event-Stream).
스키마: JSON 및 XML만 스키마를 구성할 수 있습니다. 데이터 구조에 대한 자세한 설명은 스키마를 참조하십시오. | 검증 항목 | 속성 유형 | 검증 프롬프트 예시 |
|---|
| 필수 키 존재 여부 | 모두 | $ should have required property "code" |
| 값 유형이 사양과 일치함 | 모두 | $.data.id should be integer |
| Null이 아닌 키는 null 값을 가질 수 없음 | 모두 | $.data.id should be integer |
| 열거형 값이 범위 내에 있음 | String, Integer, Number | $.data.status should be equal to one of predefined values |
| 숫자 값이 범위 내에 있음 | Integer, Number | $.data.id should be >= 0 |
| 숫자 값이 배수 요구 사항을 따름 | Integer, Number | $.data.quantity should be a multiple of 10 |
| 문자열 길이가 범위 내에 있음 | String | $.data.name should not be shorter than 3 characters |
| 문자열이 패턴과 일치함 | String | $.data.name should match pattern "^[A-Za-z]" |
| 배열 요소 수가 범위 내에 있음 | Array | $.data.tags should not have more than 2 items |
다음에 수행할 작업#
위 항목들이 일치하면 "Response Data Structure validated!"가 표시됩니다. 이는 실제 API 반환 값이 API 문서 사양과 일치한다는 의미이며, 수동 확인의 필요성을 없애고 효율성을 향상시킵니다.오른쪽에 해당 프롬프트가 표시되면, 프롬프트에 따라 문제를 해결할 수 있습니다.일반적으로 문제는 두 가지 유형이 있습니다. 첫 번째는 서버의 응답이 올바르지 않은 경우이며, 이 경우 백엔드를 사양에 맞게 수정해야 합니다. 두 번째는 API 사양이 올바르지 않은 경우이며, 엔드포인트 사양을 수정해야 합니다.자동 검증 기능을 활용하면 응답을 검증하기 위해 스크립트를 수동으로 작성할 필요가 없습니다. 또한 API 사양이 변경되면 검증도 그에 따라 자동으로 조정됩니다.다른 응답 검증#
기본적으로 Apidog는 엔드포인트의 첫 번째 응답, 일반적으로 200 응답을 검증합니다. 그러나 엔드포인트는 서로 다른 스키마를 가진 여러 다른 응답을 반환할 수 있습니다. 이러한 경우 검증 영역의 오른쪽 상단 모서리에서 검증할 응답을 선택할 수 있습니다.응답 앞의 스위치를 클릭하여 "validate" 기능을 끌 수도 있습니다. 이 변경 사항은 현재 엔드포인트에만 적용됩니다.추가 속성 검증#
실제 비즈니스가 업그레이드됨에 따라 응답에 추가 속성이 추가될 수 있습니다. 이러한 경우 Apidog는 사용자가 추가 필드를 허용할지 여부를 결정할 수 있도록 합니다.예를 들어 사용자 정보를 조회하는 API가 있고, 이전 반환 필드는 name과 phone이었습니다. 따라서 데이터 구조는 다음과 같이 지정되었습니다.비즈니스 업그레이드로 인해 이 API에 새 city 필드가 추가되었지만 API 사양은 업데이트되지 않았습니다. 기본 검증 메커니즘에 따르면 오류가 보고되지 않습니다. 즉, 추가 필드 추가는 기본적으로 허용됩니다.그러나 더 엄격한 개발 시나리오에서는 반환 값에 정의와 일치하지 않는 추가 필드가 포함되어 있는 경우 응답 검증에서도 오류를 보고해야 합니다. 이 경우 다음 단계에 따라 원하는 동작을 구현할 수 있습니다.1.
API 사양에서 응답을 수정하십시오. object의 고급 설정에서 "additionalProperties"를 "Deny"로 구성하면 현재 API에만 적용됩니다.
2.
프로젝트의 모든 API에서 추가 필드를 허용하지 않으려면 Settings → Response Validate Settings로 이동하여 Allow Objects to Have additionalProperties를 끄십시오.
3.
구성을 완료한 후 요청을 다시 보내면 응답 검증 메커니즘이 오류를 보고하여 additionalProperties가 허용되지 않음을 나타냅니다.
검증 설정#
"Validate Response" 스위치는 기본적으로 켜져 있으며, 프로젝트 설정 인터페이스의 "Verification Response Settings"에서 조정할 수 있습니다. 이 설정은 현재 프로젝트의 모든 API에만 적용되며 저장된 Endpoint Cases에는 영향을 주지 않습니다.수동 어서션 또는 사후 스크립트만 필요하고 Apidog가 API 사양과의 응답 일관성을 검증할 필요가 없는 경우, 특정 모듈에 대해 검증 기능을 비활성화할 수 있습니다.응답 콘텐츠 검증#
응답 검증에는 "HTTP Status", "Header", "Body"가 포함되며, 프로젝트 설정의 "Validate Response Content"에서 조정할 수 있습니다. 이 설정은 현재 프로젝트의 모든 API에만 적용되며 저장된 Endpoint Cases에는 영향을 주지 않습니다. Modified at 2026-06-09 08:53:32
