共有コンポーネント

以下のコードは、API コントラクトの components オブジェクトに使用できる共有コンポーネントをまとめたものです。

以降は、個々のエントリをスキーマの別の場所で再利用することができるようになります。

OpenAPI 仕様では、ここで説明されているように、スキーマファイルで JSON 参照を使用できます。これにより、スキーマ内の異なる場所でオブジェクトを複数回定義する必要がなくなり、ファイルが小さくなり、管理が容易になります。

OAS とは対照的に、カスタム API では ローカル参照、つまり同じスキーマファイルで定義されたオブジェクトへの参照のみが許可されます。具体的には、そのような参照のみが可能です。

ただし、次のようなリモート参照と URL 参照は不可能です。

$ref: '../other_schema.yaml#/components/parameters/sampleParam'
$ref: 'https://www.example.org/other_schema.yaml#/components/parameters/sampleParam'

例: 参照によるシステムクエリパラメーター siteId の使用: