API のスキーマ定義の定義

スキーマ・コンポーネントは、API 操作を呼び出す場合に実行する必要がある要求、または受け取ることが見込まれる応答に関する情報を開発者に提供する、再使用可能なスキーマを定義するものです。

このタスクについて

注: このタスクは、 OpenAPI 2.0 API 定義の構成に関連しています。 OpenAPI 3.0 API 定義の構成方法について詳しくは、 OpenAPI 3.0 API 定義の編集を参照してください。

OpenAPI 2.0 で作成された API には、API ペイロード定義が定義されているセクションが含まれています。 ペイロード定義は、 OpenAPIに固有の特殊な JSON スキーマ・バリアントを使用して、API 要求および応答で送信されるデータの構造を記述します。 各ペイロード定義は、予期されるデータ・フィールドをリストする スキーマに対応しています。 これらのデータ・フィールドは、スキーマ内のプロパティーとして表され、そのタイプ、許容値、必須状況、およびその他の特性を記述する一連の属性を含んでいます。 多数の属性が使用可能ですが、ほとんどの属性はあまり使用されません。

このタスクは、 API Designer UI アプリケーションを使用するか、ブラウザー・ベースの API Manager UI を使用して実行できます。

いつでも、 「ソース」 アイコン OpenAPI ソース・アイコンをクリックして、基礎となる OpenAPI YAML ソースに直接切り替えることができます。 設計フォームに戻るには、 「フォーム」 アイコン フォーム・アイコンをクリックします。

手順

  1. OpenAPI 2.0 API 定義の編集の説明に従って、編集のために API を開きます。
  2. 既に 1 つ以上のスキーマが定義されている場合は、 「定義」を展開します。
  3. 新規スキーマを作成することも、既存のスキーマを編集することもできます。
    • スキーマを作成するには、 「定義」の横にある追加アイコン OpenAPI 2.0 API 追加アイコン をクリックしてから、 スキーマ定義の作成を参照してください。
    • 既存のスキーマを編集するには、ナビゲーション・ペインでスキーマ・コンポーネント名をクリックし、 スキーマ定義の編集を参照してください。