説明
components.links のリンクが応答から参照されていないと、その応答と後続の操作との関係の説明に使われません。必要なリンクは応答の links に接続し、不要な定義は整理してください。
想定される影響
- 応答後に呼び出せる操作との関係が文書に十分に示されない場合があります。
- 未使用のリンク定義により、文書と実際の API の流れを比較しにくくなります。
対処方法
応答の links に名前付きの項目を作成し、リンクコンポーネントの $ref を指定してください。リンクとその対象の操作が存在することを確認してください。不要な定義は、他の文書やツールでの利用を確認してから削除してください。
例
最初の例は APIRepository を定義していますが、応答から参照していません。
変更前
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": "success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MyObject"
}
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"MyObject": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"links": {
"APIRepository": {
"operationId": "listVersionsv2"
}
}
}
}
変更後
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": "success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MyObject"
}
}
}
},
"links": {
"repository": {
"$ref": "#/components/links/APIRepository"
}
}
}
}
}
}
},
"components": {
"schemas": {
"MyObject": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"links": {
"APIRepository": {
"operationId": "listVersionsv2"
}
}
}
}
変更後は応答の links.repository から APIRepository を参照します。このリンクの対象は同じ listVersionsv2 操作であり、クライアントによる自動呼び出しを設定するものではありません。