설명
PATCH 작업은 리소스를 부분적으로 수정합니다. 성공 응답이 문서에 없으면 호출자는 수정 완료 여부와 반환 데이터를 어떻게 처리할지 알기 어렵습니다.
잠재적 영향
클라이언트나 테스트가 수정 결과를 잘못 해석해 서버와 다른 상태를 표시할 수 있습니다.
해결 방법
실제 수정 결과에 맞는 성공 코드를 정의하세요. 예를 들어 결과 본문이 있으면 200, 완료 후 본문이 없으면 204를 사용할 수 있습니다. 성공 응답의 의미와 필요한 데이터 스키마를 설명하세요.
예시
다음 OpenAPI 3.0 발췌 예시는 수정이 완료되고 본문을 반환하지 않는 경우의 204를 추가합니다.
변경 전
json
{
"openapi": "3.0.0",
"paths": {
"/item": {
"patch": {
"operationId": "updateItem",
"summary": "Updated item",
"responses": {
"default": {
"description": "Error"
}
}
}
}
}
}
변경 후
json
{
"openapi": "3.0.0",
"paths": {
"/item": {
"patch": {
"operationId": "updateItem",
"summary": "Update item",
"responses": {
"204": {
"description": "Item updated successfully"
},
"default": {
"description": "Error"
}
}
}
}
}
}