HTTP APIアクションの設定
HTTP APIアクションは以下の手順で設定します。
1. 右上のメニューから「アクション」を選択する
2. 「アクションの追加」をクリックする
3. アクション名やパラメーターを設定する
- 「データソース」で先ほど追加したHTTP APIのデータソースを選択します。
- 以下の項目を設定し、リクエスト内容を入力します。
各項目では、アクションのパラメーターを {{ パラメーター名 }} の書式で埋め込めます。URL・ヘッダーの値・クエリパラメーターの値・リクエストボディのいずれにも利用できます。
アクションのパラメーターに加えて、変数・シークレットを {{ vars.変数名 }} ・ {{ secrets.シークレット名 }} の書式で埋め込めます。データソース側で認証用アクションを設定している場合は、その実行結果を {{ authToken }} として参照できます。
HTTPメソッド
リクエストに使用するHTTPメソッドを以下から選択します。
GETPOSTPUTPATCHDELETEHEADPURGE
URL
リクエスト先のパスを入力します。データソースで設定した「データソースのURL」と連結されてリクエストが送信されます。
URLにはパスパラメーターとして、アクションのパラメーターを埋め込めます。
例： /v1/users/{{ user_id }}
URL末尾にクエリパラメーターを記述しても送信されません。クエリパラメーターは下記の「クエリパラメーター」のフォームから設定してください。
ヘッダー
アクション固有のリクエストヘッダーを「キー」「値」のペアで設定します。複数のヘッダーを追加できます。
データソースの「共通ヘッダー」と組み合わせて送信されます。
クエリパラメーター
URLに付与するクエリパラメーターを「キー」「値」のペアで設定します。複数のクエリパラメーターを追加できます。
設定した内容は ?key1=value1&key2=value2 の形式でURLに付与されてリクエストが送信されます。
リクエストタイプ
リクエストボディの形式を以下から選択します。
| リクエストタイプ | 用途 |
|---|---|
| なし | リクエストボディを送信しない、または共通ヘッダーで指定した任意の Content-Type でrawボディを送信する |
| JSON | application/json 形式のボディを送信する |
| raw | 任意のテキスト形式のボディをそのまま送信する |
| form-data | multipart/form-data 形式でボディを送信する。ファイル送信や配列送信に対応 |
| x-www-form-urlencoded | application/x-www-form-urlencoded 形式のボディを送信する |
| GraphQL | GraphQLサーバー向けにQueryとVariablesを送信する |
各リクエストタイプの詳細は、表中のリンク先のページをご参照ください。
リクエストボディ
選択した「リクエストタイプ」に応じて、リクエストボディの入力フォームが切り替わります。
HTTP APIアクションにおけるアクションパラメーターの埋め込みは基本的に単純な文字列置換となります。 そのため、複数行入力を有効にしたテキスト型パラメーターをJSONのリクエストボディに埋め込むと、改行がそのまま送信され、以下のように文字列中に改行を含む不正なJSONが生成されてエラーとなる場合があります。
{
"detail": "行1
行2"
}複数行の文字列を扱う場合は、テキスト型パラメーターの設定画面で「改行文字を指定する」を有効にし改行文字を \\n に設定するか、JSON値（種類：テキスト）をご利用ください。
リクエストボディでオブジェクトの配列を送信したい場合は、JavaScriptアクションと組み合わせて実現できます。詳しくはアクションに関する質問をご参照ください。
200系以外のレスポンスステータスコードを実行エラーとして扱う
「200系以外のレスポンスステータスコードを実行エラーとして扱う」を有効にすると、アクション実行時のHTTPレスポンスステータスコードが200系以外だった場合に、アクションを実行エラーとして扱います。
初期設定では有効になっています。
実行エラーの場合、レスポンスの内容は results[0].failure に格納されます。