説明
OpenAPI 3.0 の Parameter オブジェクトの allowReserved は、query の値に予約文字をパーセントエンコードせず含められるかを記述します。path、header、cookie のパラメーターには適用されません。
想定される影響
- API 利用者がパスの値のエンコード規則を誤解する可能性があります。
- 予約文字の解釈が異なると、受け取る値や対象のパスが変わることがあります。
対処方法
Parameter オブジェクトの allowReserved は query パラメーターでのみ使用してください。他の位置では削除し、実際のエンコード規則を明確にしてください。このプロパティを使うためだけにパラメーターの位置を変えず、API のパスとクライアントのリクエストが一致することを確認してください。
例
パスパラメーター id を比較する抜粋です。/users/{id} 操作のレスポンス定義は省略しています。
変更前
json
{
"openapi": "3.0.0",
"info": {
"title": "Simple API overview",
"version": "1.0.0"
},
"paths": {
"/{id}": {
"get": {
"operationId": "listVersionsv2",
"summary": "List API versions",
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"examples": {
"foo": {
"value": {
"versions": [
{
"status": "CURRENT",
"updated": "2011-01-21T11:33:21Z",
"id": "v2.0",
"links": [
{
"href": "http://127.0.0.1:8774/v2/",
"rel": "self"
}
]
}
]
}
}
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID of the API the version",
"required": true,
"allowReserved": true,
"schema": {
"type": "integer"
}
}
]
},
"/users/{id}": {
"get": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"allowReserved": true,
"description": "The user ID",
"schema": {
"type": "integer",
"minimum": 1
}
}
]
}
}
}
}
変更後
json
{
"openapi": "3.0.0",
"info": {
"title": "Simple API overview",
"version": "1.0.0"
},
"paths": {
"/{id}": {
"get": {
"operationId": "listVersionsv2",
"summary": "List API versions",
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"examples": {
"foo": {
"value": {
"versions": [
{
"status": "CURRENT",
"updated": "2011-01-21T11:33:21Z",
"id": "v2.0",
"links": [
{
"href": "http://127.0.0.1:8774/v2/",
"rel": "self"
}
]
}
]
}
}
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID of the API the version",
"required": true,
"schema": {
"type": "integer"
}
}
]
},
"/users/{id}": {
"get": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The user ID",
"schema": {
"type": "integer",
"minimum": 1
}
}
]
}
}
}
}
変更後はパスパラメーターを維持したまま、適用されない allowReserved を削除しています。パスの値は、実際の URI エンコード規則に従う必要があります。