要求本文の編集

オンラインで編集する

要求本文は、API 要求の本文の構造を定義します。

開始前に

リクエスト本文の詳細フォームを開きます。 詳細は「リクエスト本文の構成要素の定義」 を参照してください。

このタスクについて

注:
  • このタスクは OpenAPI 3.0 API 定義の構成に関連しています。 OpenAPI 2.0 API 定義の構成方法について詳しくは、 OpenAPI 2.0 API 定義の編集を参照してください。
  • OpenAPI 3.0 API は、 DataPower® API Gatewayでのみサポートされ、 DataPower Gateway (v5 compatible)ではサポートされません。
  • 現在の OpenAPI 3.0 サポートの制限について詳しくは、 IBM® API Connect での OpenAPI 3.0 のサポートを参照してください。

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

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

手順

  1. 以下の情報を指定します。
    • 「名前」: 要求本体の名前。
      要求本文コンポーネントを作成する場合に使用可能です。この名前は、API 定義内の他の場所からこの要求本文を参照できるようにするためのキーを定義します。参照の形式は次のとおりです。
      #/components/requestBodies/Name
    • 「説明」: 要求本体の説明。 リッチテキストの表現には、 CommonMark 構文を使用できます。
    • コンテンツ: コンテンツ定義では、要求本文のコンテンツを記述します。

      リクエスト本文の新しいコンテンツ定義を作成するには、 「追加」 をクリックし、「 コンテンツ定義の作成 」を参照してください。

      既存のコンテンツ定義を編集するには、コンテンツ定義の名前をクリックし、「 コンテンツ定義の編集」 を参照してください。

    • 必須: 要求に要求本文が必要がどうかを決定します。
  2. 完了したら、 「保存」 をクリックします。

次のタスク

必要に応じて、パンくずリストを使用して、作業対象のオブジェクトの階層内の別の場所にナビゲートします。