スキーマ定義の作成

スキーマは、API 操作を呼び出す場合に実行する必要がある要求、または受け取ることが見込まれる応答に関する情報を開発者に提供します。 API 定義内のさまざまな場所でスキーマを作成することができます。

開始前に

注: スキーマは、検証に使用される前にコンパイルされます。 このコンパイル・プロセスには妥当性検査プロセスよりも時間がかかるので、コンパイルされたスキーマ成果物はキャッシュに保管されます。 このキャッシュの容量には限度があるので、新しいエントリーが追加されると、古いエントリーがキャッシュから除去されることがあります。 成果物がキャッシュから除去されたスキーマは再コンパイルする必要があります。これによって妥当性検査が大幅に遅くなることがあります。
スキーマを作成できる API 定義内の領域の詳細については、以下のトピックを参照してください。

このタスクについて

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

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

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

手順

  1. スキーマ定義を作成するには、 「定義」の横にある追加アイコン OpenAPI 2.0 API 追加アイコン をクリックします。
    スキーマの 「オブジェクトの追加」 ウィザードが表示されます。
  2. 以下の情報を指定します。
    • スキーマ名: この名前は、API 定義内の他の場所からこのスキーマを参照できるようにするキーを定義します。参照の形式は以下のとおりです。
      #/definitions/Name
    • タイトル: スキーマのタイトル。
    • タイプ: スキーマのデータ・タイプ。以下のいずれかを選択します。
      • アレイ
      • ブール値
      • 整数
      • 数値
      • object
      • string
  3. 「作成」をクリックします。
    さらに編集するために、スキーマ定義の詳細が表示されます。 スキーマ定義の編集を参照してください。