仕様の拡張

OpenAPI 仕様はほとんどのユースケースに対応しようとしていますが、特定の時点で追加データを追加して仕様を拡張することができます。

拡張プロパティは、常に先頭に が付くパターン化されたフィールドとして実装されます"x-"。

フィールドパターン	タイプ	説明
^x-	どれでも	OpenAPI スキーマの拡張を許可します。フィールド名はx-、たとえば、x-internal-idで始まる必要があります。x-oai-とx-oas-で始まるフィールド名は、OpenAPI Initiativeによって定義された用途のために予約されています。値はnull、プリミティブ、配列、またはオブジェクトです。

拡張機能は利用可能なツールでサポートされる場合とサポートされない場合がありますが、要求されたサポートを追加するために拡張される場合もあります (ツールが内部またはオープンソースである場合)。