説明
OpenAPI 3.0で最上位のserversがない場合や空の配列の場合、URLが/のサーバーがデフォルトになります。有効な設定ですが、文書を提供するホストのルートが実際のAPIアドレスか確認が必要です。
想定される影響
デフォルトのアドレスと配置済みのAPIが異なると、ドキュメントツールや生成されたクライアントが誤った場所へリクエストを送る場合があります。serversの省略だけで、実際のサーバーが存在しない、または公開されているとは判断できません。
対処方法
デフォルトURLの/が意図したアドレスか確認してください。別のサーバーが必要ならservers配列に実際のURLを明記し、パスや操作ごとの上書き設定も確認してください。
例
デフォルトのサーバーアドレスと、明示したアドレスを比較します。どちらもOpenAPIで許可された構成です。
変更前
json
{
"openapi": "3.0.0",
"info": {
"title": "Simple API Overview",
"version": "1.0.0"
},
"paths": {
"/": {
"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"
}
]
}
]
}
}
}
}
}
}
}
}
}
}
}
変更後
json
{
"openapi": "3.0.0",
"info": {
"title": "Simple API Overview",
"version": "1.0.0"
},
"paths": {
"/": {
"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"
}
]
}
]
}
}
}
}
}
}
}
}
}
},
"servers": [
{
"url": "https://my.api.server.com/",
"description": "My API Server"
}
]
}
変更前はデフォルトURLの/を使います。変更後はhttps://my.api.server.com/を指定しているため、その場所で実際にAPIが提供されているか確認してください。