설명
OpenAPI 2.0의 produces는 응답 본문의 미디어 유형을 나타냅니다. 응답 본문을 반환하는 GET 작업에 전역 또는 작업별 정의가 없으면 클라이언트가 어떤 형식을 기대해야 하는지 판단하기 어렵습니다.
잠재적 영향
클라이언트가 잘못된 파서나 응답 형식을 선택해 데이터를 처리하지 못할 수 있습니다.
해결 방법
전역 produces 또는 개별 작업에 실제 응답 미디어 유형을 명시하십시오. 작업별 정의는 전역 값을 덮어씁니다. 응답 본문과 Content-Type 헤더가 문서와 일치하는지도 확인하십시오.
예시
예시는 JSON 응답을 반환하는 작업에 produces: [application/json]을 추가합니다.
변경 전
yaml
swagger: "2.0"
paths:
/users:
get:
responses:
"200":
description: ok
변경 후
yaml
swagger: "2.0"
paths:
/users:
get:
produces:
- application/json
responses:
"200":
description: ok