설명
OpenAPI 2.0의 본문 매개변수는 name, in, description, required, schema 필드를 사용합니다. 사용자 정의 확장은 x-로 시작해야 하며, desc 같은 임의 속성은 표준 필드가 아닙니다.
잠재적 영향
문서 검증이 실패하거나 도구가 속성을 무시해 요청 본문의 설명을 잘못 해석할 수 있습니다.
해결 방법
잘못된 속성을 제거하거나 올바른 표준 필드로 옮기세요. 추가 설명에는 description, 본문 구조에는 schema를 사용하세요. 확장이 필요하면 x- 접두사를 사용하고 도구의 지원 여부를 확인하세요.
예시
다음 본문 매개변수 예시는 알 수 없는 desc를 제거합니다. 변경 후 예시는 최대 레코드 수를 정수로 정의합니다.
변경 전
json
{
"name": "limit",
"in": "body",
"description": "max records to return",
"required": true,
"schema": {
"type": "string"
},
"desc": {
"type": "string"
}
}
변경 후
json
{
"name": "limit",
"in": "body",
"description": "max records to return",
"required": true,
"schema": {
"type": "integer"
}
}