応答の編集

オンラインで編集する

応答は、応答の本文およびヘッダーで返される HTTP 状況コードおよびデータを定義します。 API 定義では、以前に作成されたパス操作の応答を編集できます。

開始前に

応答の詳細フォームを開きます。 応答を編集できる API 定義内の領域の詳細については、以下のトピックを参照してください。

このタスクについて

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

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

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

手順

  1. 以下の情報を指定します。
    • 名称 ： HTTP ステータスコード。
    • 「説明」 (必須): 応答の説明。
    • スキーマ: スキーマは応答構造を定義します。

      レスポンスのスキーマを定義するには、 「作成」 をクリックし、その後 「スキーマ定義の作成」 を参照してください。

      応答に既にスキーマが定義されている場合は、 「表示」 をクリックしてスキーマを編集します。

      スキーマの編集に関する詳細については、 「スキーマ定義の編集」 を参照してください。

  2. 完了したら、 「保存」 をクリックします。

次のタスク

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