外部参照を含むOpenAPIドキュメントのサポート
外部参照を含むOpenAPIドキュメントは、HTTPベースとHTTPSベースの両方のURLでサポートされています。
次のガイドラインに留意してください。
- すべての参照のベースURLは同じである必要があります:
http://dummyhost/resources/openapi/main.json http://dummyhost/resources/openapi/reference.jsonまたはhttps://dummyhost/resources/openapi/main.json https://dummyhost/resources/openapi/reference.json - プロトコルは、すべての参照に対してHTTPまたはHTTPSである必要があります。 (HTTPからHTTPSへのリダイレクト、またはその逆のリダイレクトはありません。)
- URLは保護されていない(つまり、認証されていない)必要があります。
- 参照は、相対URLと絶対URLの両方でサポートされています。
両方の参照の例を次に示します:
絶対参照 相対参照 "Request": { "$ref": "http://dummyhost/resources/openapi/RequestReference.json#/components/schemas/ReferredSchema" }"Request": { "$ref": "RequestReference.json#/components/schemas/ReferredSchema" } - 参照はスキーマ・レベルでのみサポートされます(パス・レベルではサポートされません)。
- メインのOpenAPIドキュメントに関連付けられているパスのみが考慮されます。 参照内のパスはすべて無視されます。