オペレーションに対して1つまたは複数のレスポンスを定義します。
手順
-
オペレーションにレスポンスを追加するには、オペレーションの名前をクリックし、[RESPONSES] (レスポンス)セクションまで下にスクロールして[Add] (追加)をクリックします。
-
ステータスコードを選択し、必要に応じて説明を追加します。
選択できるオプションは次のとおりです。
- 200などの特定のステータスコード
- 2XXなどの応答範囲
- [Default] (デフォルト)のレスポンス
-
ヘッダーを追加するには、[HEADERS] (ヘッダー)の右側の[Add] (追加)をクリックします。
-
[Name] (名前)を入力します。
名前の入力を開始して、ヘッダーのドロップダウンリストを表示します。
例
-
[Type] (タイプ)を選択します。
再利用可能なデータ型を使用できます。
-
[more attributes] (その他の属性)をクリックして、レスポンスに情報を追加します。
-
さらにヘッダーを定義する必要がある場合は、[Add a header] (ヘッダーの追加)をクリックし、前の手順を必要な回数だけ繰り返します。
-
ボディを定義するには、[BODY] (ボディ)の右側の[Add] (追加)をクリックします。
レスポンス値を他のオペレーションにリンクすることはサポートされていません。
-
必要に応じて[Media Types] (メディアタイプ)フィールドをクリックしてメディアタイプを追加します。
必要な数のメディアタイプを追加できます。
-
必要に応じて[Description] (説明)を入力します。
-
[Type] (タイプ)を選択し、対応するプロパティを追加します。
再利用可能なデータ型を使用することも、新しいデータ型を作成することもできます。作成したデータ型をAPIで保存して再利用する場合は、
[Extract data type] (データ型を抽出)をクリックします。
ヒント: [Examples] (例)、[Enum] (列挙型)または[Default] (デフォルト)のヘッダーに値を追加すると、Talend Cloud API Testerでモックをテストする時に、ヘッダーが返されます。
例
-
必要に応じて、[BODY]右側の[Add] (追加)をクリックして、さまざまなメディアタイプで新しいボディを定義します。
-
必要に応じて、[RESPONSES] (レスポンス)右側の[Add] (追加)をクリックして新しい回答を追加します。
各ステータスコードが一意である限り、必要に応じてレスポンスを追加できます。
-
[Save] (保存)をクリックします。
