説明
OpenAPIのinfo.contact.urlは、APIの連絡先情報を提供するページを指します。OpenAPI 3.0では相対URLも許可されるため、/自体が不正な形式とは限りません。サーバーURLを基準に解決した先が、実際のサポートページか確認してください。
想定される影響
誤った接続先や切れたリンクにより、API利用者がサポート窓口を見つけにくくなります。
対処方法
アドレスの表記と実際のリンク先を確認してください。相対アドレスでは基準URLとツールの処理を確認し、独立したサポートサイトならスキームとホストを含むURLを明記してください。
例
OpenAPI 3.0の相対パス/と絶対URLを比較します。許可された形式であることだけでは、APIのサポート情報を提供するページだとは保証できません。
変更前
json
{
"openapi": "3.0.0",
"info": {
"title": "Simple API Overview",
"version": "1.0.0",
"contact": {
"name": "contact",
"url": "/",
"email": "user@gmail.com"
}
},
"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",
"contact": {
"name": "contact",
"url": "https://www.google.com/",
"email": "user@gmail.com"
}
},
"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"
}
]
}
]
}
}
}
}
}
}
}
}
}
}
}
変更後のURLはGoogleのホームページを使った例です。実際のAPIサポートページに置き換え、文書から正しく移動できるか確認してください。