OpenAPI 2.0 미디어 타입 접두사 점검

설명

OpenAPI 2.0의 미디어 타입은 application/json처럼 type/subtype 형식으로 작성합니다. 상위 타입의 오타나 부적절한 값은 실제 콘텐츠 형식을 잘못 전달하고 도구 간 상호 운용성을 떨어뜨릴 수 있습니다.

잠재적 영향

문서나 생성된 클라이언트가 잘못된 미디어 타입을 사용할 수 있습니다.
서버와 클라이언트가 기대하는 형식이 달라 요청이나 응답 처리가 실패할 수 있습니다.

해결 방법

실제 데이터 형식에 맞는 미디어 타입을 확인하고 상위 타입과 하위 타입의 오타를 수정하세요. consumes와 produces의 전역 및 작업별 선언을 검토하고 실제 Content-Type과 일치시키세요.

예시

첫 예제의 aplication/json은 application/json의 오타입니다.

변경 전

json

{
  "swagger": "2.0",
  "info": {
    "title": "Simple API Overview",
    "version": "1.0.0"
  },
  "paths": {
    "/": {
      "get": {
        "operationId": "listVersionsv2",
        "summary": "List API versions",
        "produces": [
          "aplication/json"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/User"
            }
          }
        },
        "parameters": [
          {
            "$ref": "#/parameters/limitParam"
          }
        ]
      }
    }
  },
  "parameters": {
    "limitParam": {
      "name": "limit",
      "in": "query",
      "description": "max records to return",
      "required": true,
      "type": "integer"
    }
  },
  "definitions": {
    "User": {
      "type": "object",
      "required": [
        "id",
        "name"
      ],
      "properties": {
        "id": {
          "type": "integer",
          "format": "int64"
        },
        "name": {
          "type": "string"
        }
      }
    }
  }
}

변경 후