説明
OpenAPI 3.0 の例は、要求や応答のデータを理解するために役立ちます。ローカルの $ref が components.examples に存在しない名前を指すと、ツールは例のデータを表示したり再利用したりできません。
想定される影響
- 要求や応答の例が文書から欠けたり、誤って表示されたりする可能性があります。
- 参照エラーによって検証や文書生成が失敗する可能性があります。
- API の利用者がデータ構造を理解するのに時間がかかる場合があります。
対処方法
例の $ref が対象の components.examples 項目を指すことを確認してください。改名、削除、誤記による不一致を修正し、外部参照の URI と参照先も検証してください。例が実際のスキーマとメディアタイプに合うことを確認してください。
例
最初の文書は objectExample を定義していますが、存在しない wrongExample を参照しています。
変更前
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": {
"$ref": "#/components/schemas/MyObject"
},
"examples": {
"objectExample": {
"$ref": "#/components/examples/wrongExample"
}
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"MyObject": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"examples": {
"objectExample": {
"value": {
"id": "1",
"name": "new object"
},
"summary": "A sample object"
}
}
}
}
変更後
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": {
"$ref": "#/components/schemas/MyObject"
},
"examples": {
"objectExample": {
"$ref": "#/components/examples/objectExample"
}
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"MyObject": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"examples": {
"objectExample": {
"value": {
"id": "1",
"name": "new object"
},
"summary": "A sample object"
}
}
}
}
変更後は実際に定義された objectExample を参照します。参照を修正してもサーバーの応答データは自動で変わらないため、実際の応答と例を合わせて管理してください。