説明
OpenAPI 2.0では、1つの操作に定義できる in: body パラメーターは最大1つです。本文で複数の値を送る場合は、1つの本文スキーマにまとめる必要があります。
想定される影響
文書の検証やコード生成に失敗したり、クライアントが誤ったリクエスト本文を構成したりする可能性があります。
対処方法
本文に必要な値を1つのオブジェクトスキーマにまとめてください。クエリやヘッダーへの移動は、実際のAPIがその場所で受け取る値に限ってください。本文パラメーターと formData は併用できません。
例
次の POST の例では、本文パラメーターを1つにし、pageCount を整数のクエリパラメーターとして定義しています。実際のAPIもこのリクエスト形式に対応する必要があります。
変更前
json
{
"swagger": "2.0",
"info": {
"title": "Simple API Overview",
"version": "1.0.0"
},
"paths": {
"/": {
"post": {
"parameters": [
{
"name": "limit",
"in": "body",
"description": "max records to return",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "limit2",
"in": "body",
"description": "max records to return",
"required": true,
"schema": {
"type": "string"
}
}
],
"operationId": "listVersionsv2",
"summary": "List API versions",
"responses": {
"200": {
"description": "200 response"
}
}
}
}
}
}
変更後
json
{
"swagger": "2.0",
"info": {
"title": "Simple API Overview",
"version": "1.0.0"
},
"paths": {
"/": {
"post": {
"parameters": [
{
"name": "limit",
"in": "body",
"description": "max records to return",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "pageCount",
"in": "query",
"description": "records per page",
"required": true,
"type": "integer"
}
],
"operationId": "listVersionsv2",
"summary": "List API versions",
"responses": {
"200": {
"description": "200 response"
}
}
}
}
}
}