존재하지 않는 OpenAPI 3.0 스키마 참조

설명

OpenAPI 3.0에서는 데이터 구조를 components.schemas에 정의하고 $ref로 재사용할 수 있습니다. 존재하지 않는 스키마를 참조하면 요청이나 응답의 필드와 자료형을 문서 도구가 해석하지 못할 수 있습니다.

잠재적 영향

요청 또는 응답 구조가 문서에서 제대로 표시되지 않을 수 있습니다.
코드 생성이나 검증이 실패하고, API 사용자가 필드와 자료형을 잘못 가정할 수 있습니다.

해결 방법

스키마 $ref의 경로와 이름을 실제 Schema 객체에 맞추세요. 로컬 참조는 components.schemas의 정의를 확인하고, 외부 참조는 대상 문서와 경로도 확인하세요. 이름을 바꿀 때 모든 사용 위치를 갱신한 뒤 문서와 데이터 구조를 검증하세요.

예시

응답의 content 안에서 JSON 스키마를 참조하는 예시입니다. 첫 예제의 MyWrongObject는 정의되어 있지 않습니다.

변경 전

json

{
  "openapi": "3.0.0",
  "info": {
    "title": "Simple API Overview",
    "version": "1.0.0"
  },
  "paths": {
    "/": {
      "get": {
        "operationId": "listVersionsv2",
        "summary": "List API versions",
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MyWrongObject"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "MyObject": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        }
      }
    }
  }
}

변경 후

json

{
  "openapi": "3.0.0",
  "info": {
    "title": "Simple API Overview",
    "version": "1.0.0"
  },
  "paths": {
    "/": {
      "get": {
        "operationId": "listVersionsv2",
        "summary": "List API versions",
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MyObject"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "MyObject": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        }
      }
    }
  }
}

변경 후에는 MyObject를 참조해 id와 name의 문자열 형식을 설명합니다. 스키마는 응답 전체를 대신하는 것이 아니라 본문의 데이터 구조를 정의합니다.