OpenAPI オブジェクト
これは、 OpenAPI ドキュメントのルート オブジェクトです。
固定フィールド
| フィールド名 | タイプ | 説明 |
|---|---|---|
| オープンアピ | string | 必須。この文字列は、OpenAPI ドキュメントが使用する OpenAPI 仕様のバージョン番号でなければなりません。このopenapiフィールドは、OpenAPI ドキュメントを解釈するツールによって使用されるべきです (SHOULD)。これはAPI info.version文字列とは関係ありません。 |
| 情報 | Infoオブジェクト | 必須。API に関するメタデータを提供します。メタデータは、必要に応じてツールによって使用されてもよい(MAY)。 |
| jsonスキーマ方言 | string | この OAS ドキュメント内に含まれるスキーマ オブジェクト内の$schemaキーワードのデフォルト値。これは URI の形式でなければなりません。 |
| サーバー | [Serverオブジェクト] | ターゲット サーバーに接続情報を提供するサーバー オブジェクトの配列。serversプロパティが指定されていない場合、または空の配列の場合、デフォルト値はURL値が/のサーバー オブジェクトになります。 |
| パス | Pathsオブジェクト | API で使用可能なパスと操作。 |
| Webhook | Map[ string,Path Itemsオブジェクト| Referenceオブジェクト] ] | この API の一部として受信される可能性があり、API コンシューマーが実装することを選択できる受信 Webhook。このcallbacks機能と密接に関連するこのセクションでは、API 呼び出し以外で開始されるリクエスト (帯域外登録など) について説明します。キー名は各 Webhook を参照する一意の文字列であり、(オプションで参照される) パス アイテム オブジェクトは、API プロバイダーによって開始される可能性のあるリクエストと予期される応答を記述します。例が用意されています。 |
| コンポーネント | Componentsオブジェクト | ドキュメントのさまざまなスキーマを保持する要素。 |
| 安全 | [Security Requirementオブジェクト] | API 全体でどのセキュリティ メカニズムを使用できるかの宣言。値のリストには、使用できる代替セキュリティ要件オブジェクトが含まれています。リクエストを承認するには、セキュリティ要件オブジェクトのうち 1 つだけを満たす必要があります。個々の操作でこの定義をオーバーライドできます。セキュリティをオプションにするには、空のセキュリティ要件 ( {}) を配列に含めることができます。 |
| タグ | [Tagオブジェクト] | 追加のメタデータを含むドキュメントで使用されるタグのリスト。タグの順序は、解析ツールによる順序を反映するために使用できます。操作オブジェクトで使用されるすべてのタグを宣言する必要はありません。宣言されていないタグは、ランダムに編成することも、ツールのロジックに基づいて編成することもできます (MAY)。リスト内の各タグ名は一意である必要があります。 |
| 外部ドキュメント | External Documentationオブジェクト | 追加の外部ドキュメント。 |
このオブジェクトは、仕様拡張機能を使用して拡張できます。