説明
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"
}
}
}
}
}
変更後
json
{
"swagger": "2.0",
"info": {
"title": "Simple API Overview",
"version": "1.0.0"
},
"paths": {
"/": {
"get": {
"operationId": "listVersionsv2",
"summary": "List API versions",
"produces": [
"application/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"
}
}
}
}
}
変更後は正しい application/json を使用しています。サーバーが実際に JSON を返すことも確認してください。