説明
collectionFormat: multi は、同じパラメーター名を繰り返して配列を送る形式です。OpenAPI 2.0では、query と formData のパラメーターでのみ使用できます。
想定される影響
クライアントがサーバーの想定と異なる形式で配列を送信し、リクエストに失敗する可能性があります。
対処方法
パラメーターの場所と実際のリクエスト形式に合うシリアライズ方法を選んでください。path や header の配列には csv などの対応する形式を使い、場所を変える場合もサーバーのリクエスト契約に合わせてください。
例
次の例では、limit2 を query に移して multi を使っています。別の再利用可能な path 定義である limitParam には csv を指定しています。
変更前
json
{
"swagger": "2.0",
"info": {
"title": "Simple API Overview",
"version": "1.0.0"
},
"paths": {
"/{limit2}": {
"get": {
"parameters": [
{
"name": "limit2",
"in": "path",
"description": "max records to return",
"required": true,
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"collectionFormat": "multi"
}
],
"operationId": "listVersionsV2",
"summary": "List API versions",
"responses": {
"200": {
"description": "200 response"
}
}
}
}
},
"parameters": {
"limitParam": {
"name": "limit",
"in": "path",
"description": "max records to return",
"required": true,
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"collectionFormat": "multi"
}
}
}
変更後
json
{
"swagger": "2.0",
"info": {
"title": "Simple API Overview",
"version": "1.0.0"
},
"paths": {
"/": {
"get": {
"parameters": [
{
"name": "limit2",
"in": "query",
"description": "max records to return",
"required": true,
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"collectionFormat": "multi"
}
],
"operationId": "listVersionsV2",
"summary": "List API versions",
"responses": {
"200": {
"description": "200 response"
}
}
}
}
},
"parameters": {
"limitParam": {
"name": "limit",
"in": "path",
"description": "max records to return",
"required": true,
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"collectionFormat": "csv"
}
}
}