존재하지 않는 OpenAPI 3.0 콜백 참조

설명

OpenAPI 3.0의 콜백은 API 제공자가 수행할 후속 요청을 문서화합니다. #/components/callbacks/로 시작하는 로컬 $ref가 존재하지 않는 이름을 가리키면 도구가 해당 콜백 정의를 해석할 수 없습니다.

잠재적 영향

비동기 이벤트나 웹훅 흐름이 문서에서 빠지거나 잘못 표시될 수 있습니다.
참조 검증 오류로 문서 생성이나 코드 생성이 실패할 수 있습니다.
API 사용자가 후속 요청의 URL이나 형식을 잘못 이해할 수 있습니다.

해결 방법

로컬 콜백 $ref가 components.callbacks의 실제 이름과 정확히 일치하는지 확인하세요. 이름을 바꾸면 모든 참조를 함께 수정하고, 외부 문서를 참조한다면 그 URI와 대상도 검증하세요. 콜백 URL 표현식에 필요한 실제 요청 값도 확인하세요.

예시

다음 POST 작업은 inProgress를 참조합니다. 첫 문서에는 onProgress만 있으며, 콜백 URL을 제공하는 요청 본문 정의는 생략했습니다.

변경 전

json

{
  "openapi": "3.0.0",
  "info": {
    "title": "Simple API Overview",
    "version": "1.0.0"
  },
  "paths": {
    "/": {
      "post": {
        "operationId": "listVersionsv2",
        "summary": "List API versions",
        "responses": {
          "200": {
            "description": "Success"
          }
        },
        "callbacks": {
          "myEvent": {
            "$ref": "#/components/callbacks/inProgress"
          }
        }
      }
    }
  },
  "components": {
    "callbacks": {
      "onProgress": {
        "{$request.body#/onProgressUrl}": {
          "delete": {
            "responses": {
              "204": {
                "description": "Deleted"
              }
            }
          }
        }
      }
    }
  }
}

변경 후

json

{
  "openapi": "3.0.0",
  "info": {
    "title": "Simple API Overview",
    "version": "1.0.0"
  },
  "paths": {
    "/": {
      "post": {
        "operationId": "listVersionsv2",
        "summary": "List API versions",
        "responses": {
          "200": {
            "description": "Success"
          }
        },
        "callbacks": {
          "myEvent": {
            "$ref": "#/components/callbacks/inProgress"
          }
        }
      }
    }
  },
  "components": {
    "callbacks": {
      "inProgress": {
        "{$request.body#/inProgressUrl}": {
          "delete": {
            "responses": {
              "204": {
                "description": "Deleted"
              }
            }
          }
        }
      }
    }
  }
}

변경 후에는 참조 대상인 inProgress를 정의합니다. 실제 요청 본문에 inProgressUrl 값이 있어야 이 예제의 콜백 URL 표현식을 사용할 수 있습니다.