설명
HEAD는 응답 본문 없이 리소스의 메타데이터를 조회합니다. 성공 응답이 정의되지 않으면 호출자와 자동화 도구가 정상 결과를 판단하기 어렵습니다.
잠재적 영향
존재 여부 확인이나 상태 점검에 사용하는 클라이언트가 정상 응답을 실패로 처리할 수 있습니다.
해결 방법
실제로 반환하는 200 등의 성공 상태 코드와 의미를 responses에 정의하세요. 필요한 응답 헤더를 설명하되, HEAD 응답에는 본문을 정의하지 마세요.
예시
다음 OpenAPI 3.0 발췌 예시는 오류로 설명된 default 외에 200 성공 응답을 추가합니다.
변경 전
json
{
"openapi": "3.0.0",
"paths": {
"/item": {
"head": {
"operationId": "headItem",
"summary": "Head item",
"responses": {
"default": {
"description": "Error"
}
}
}
}
}
}
변경 후
json
{
"openapi": "3.0.0",
"paths": {
"/item": {
"head": {
"operationId": "headItem",
"summary": "Head item",
"responses": {
"200": {
"description": "Success"
},
"default": {
"description": "Error"
}
}
}
}
}
}