説明
OpenAPI 3.0 の allowEmptyValue は query パラメーターでのみ有効で、選択したスタイルで値を直列化できない場合には適用されません。仕様でもこのプロパティの使用は推奨されていません。設定しただけで、すべてのパラメーターが空値を受け付けるわけではありません。
想定される影響
- API 利用者が空値を送信できると誤解する可能性があります。
- 文書とサーバーの入力規則が異なると、リクエストの失敗やテストの混乱につながります。
対処方法
path パラメーターなど、適用対象でない定義から allowEmptyValue を削除してください。空値とパラメーターの省略を区別して許可方針を定め、値のスキーマと直列化方法に合わせてください。クライアントのリクエストとサーバーの検証で実際の処理を確認してください。
例
以下は整数のパスパラメーター id を記述した例です。このパラメーターは allowEmptyValue の適用対象ではありません。
変更前
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 version",
"required": true,
"allowEmptyValue": true,
"schema": {
"type": "integer"
}
}
]
}
}
}
変更後
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": [
{
"in": "path",
"style": "label",
"description": "ID of the API version",
"required": true,
"schema": {
"type": "integer"
},
"name": "id"
}
]
}
}
}
変更後はパスパラメーターから allowEmptyValue を削除しています。style: label はパスの直列化方法を指定するもので、空の整数値を許可する設定ではありません。