レスポンスコンポーネントを作成

複数の操作で使用できるレスポンスコンポーネントを作成します。

このタスクについて

この例では、エラーが発生した場合のレスポンスを定義する必要があります。すべての操作用に同じレスポンスの使用が必要です。

左パネルにある[+]ボタンをクリックして、[Response] (レスポンス)をクリックします。
[Name] (名前)フィールド内にErrorを入力して、説明を追加します。
[BODY] (ボディ)の横にある[Add] (追加)をクリックした後、[TYPE] (タイプ)の下にある[Add property] (プロパティを追加)をクリックします。
[Name] (名前)フィールド内にmessageを入力して、[Examples] (例)フィールド内にAn error occurred, please try again or contact supportを入力します。
[Save] (保存)をクリックします。

レスポンスコンポーネントが作成され、それをAPI内のどの操作にも追加できるようになりました。

このページまたはコンテンツに、タイポ、ステップの省略、技術的エラーなどの問題が見つかった場合は、お知らせください。改善に役立たせていただきます。