설명
TRACE는 서버가 수신한 요청을 되돌려주는 진단용 메서드입니다. 실제로 지원하는 작업의 200 성공 응답이 문서에 없으면 호출자가 정상 결과를 이해하기 어렵습니다.
잠재적 영향
문서 기반 클라이언트나 테스트가 진단 응답을 잘못 해석할 수 있습니다.
해결 방법
지원하는 TRACE 작업의 responses에 200과 응답 형식을 설명하세요. TRACE를 지원하지 않는 서비스라면 문서에서도 해당 작업을 제거하세요.
예시
다음 OpenAPI 3.0 발췌 예시는 이미 지원하는 TRACE 작업에 200 응답을 추가합니다. 이 문서 변경이 서버에서 메서드를 활성화하는 것은 아닙니다.
변경 전
json
{
"openapi": "3.0.0",
"paths": {
"/item": {
"trace": {
"operationId": "traceItem",
"responses": {
"default": {
"description": "Error"
}
}
}
}
}
}
변경 후
json
{
"openapi": "3.0.0",
"paths": {
"/item": {
"trace": {
"operationId": "traceItem",
"responses": {
"200": {
"description": "success"
},
"default": {
"description": "Error"
}
}
}
}
}
}