APIリクエストの詳細

APIテストエディターでのリクエストの設定

APIテストエディターの [Request details] セクションを使用すると、各APIリクエストの詳細を設定できます。APIテストのステップには、少なくとも次の項目が含まれています。

  • HTTPメソッド: GET、POST、PUT、PATCH、FETCH、DELETE、HEAD、OPTIONS
  • URL: URLは、APIエンドポイントとも呼ばれます。APIベースURLを参照するmabl変数 (api.url) を使用できます。
2390

[Request details] パネル

リクエストで送信する必要のあるデータに応じて、[URL] 入力フィールドの下にある次のタブも使用できます。[AUTH]、[PARAMS]、[HEADERS]、[BODY]、[PRE-REQUEST]、[SETTINGS]

認証

認証方法として、APIキー、Basic認証、ベアラートークン、OAuth 1.0がサポートされています。他の認証方法のサポートが必要な場合は、プロダクトポータル (mabl Product Portal)でお問い合わせください。

📘

フローレベルの認証設定

APIテストのすべてのリクエストに同一の認証を適用するには、APIテストエディターのEdit flow properties(フローレベルの設定)モーダルウィンドウを開き、[AUTH] タブをクリックします。

Inherit auth from parent (上位の認証設定を利用)

この特定のステップに、フローレベルでの認証設定を使用します。

No auth (認証なし)

テストにフローレベルの認証が設定されており、この設定を含めずにAPIリクエストを送信する場合は、[No auth] を使用します。

API Key (APIキー)

APIキーの名前と値を入力します。次に、キーをリクエストヘッダーで送信するか、クエリパラメーターで送信するかを指定します。

1510

APIキーを使用するリクエストの例

Basic Auth (BASIC認証)

このAPIリクエストで送信するユーザー名とパスワードを入力します。

1510

Basic認証を使用するリクエストの例

Bearer Token (ベアラトークン)

入力フィールドにトークンを入力します。この認証方法では、リクエストヘッダAuthorizationBearer <your_token_value> という値をつけて送信します。

OAuth 1.0

[Signature Method] から値を選択し、テスト対象APIに必要な次の値を指定します。
Consumer Key
Consumer Secret
Access Token
Token Secret

[Add To] ドロップダウンをクリックし、OAuth 1.0の詳細をヘッダーで送信するか、URLで送信するかを選択します。デフォルトでは、OAuth 1.0はヘッダーで送信されます。

必要に応じて追加の値を設定するには、[Show advanced settings] をオンに切り替えます。次の項目があります。

  • Callback URL
  • Nonce
  • Realm
  • Timestamp
  • Verifier
  • Version
  • Add empty parameters to signature
  • Include body hash

PARAMS

クエリパラメーターをキーと値のペアの形式で指定します。このパラメーターはAPI URLに追加されます。

HEADERS

リクエストヘッダーをキー名(Key)と値(Value)のペアの形式で入力します。必要に応じて説明(Description)を追加します。

BODY

[BODY] のフィールドは、リクエストに対してデータの追加や更新を行うために使用します。サポートされる形式には、rawテキスト (テキスト、JSON、XML、HTML)、formdata、x-www-form-urlencoded、バイナリ、GraphQLなどがあります。

ファイルのアップロード

リクエストタイプが "formdata" または「バイナリ」の場合、ファイルのアップロードがサポートされています。

formdataリクエストタイプでファイルをアップロードするには、[BODY] タブの [formdata] をクリックし、[Type] ドロップダウンから [File] を選択します。コンピューターから新しいファイルをアップロードすることもできますし、ワークスペースから既存のファイルを選択することもできます。

1456

formdataリクエストボディでのファイルのアップロード

「バイナリ」リクエストタイプでファイルをアップロードするには、[BODY] タブの [binary] を選択し、ローカルファイルをアップロードするか、ワークスペースから既存のファイルを選択します。

1484

バイナリリクエストボディでのファイルのアップロード

テストを保存すると、新しいファイルはmablクラウドにアップロードされ、クラウド実行でそのファイルがりようできるようになります。ワークスペースでのファイルアップロードは、アプリケーションの [ファイルアップロード] ページで管理できます。このページを表示するには、[テスト環境設定] > [ファイルアップロード] を選択してください。

リクエスト前(PRE-REQUEST)実行スクリプト

HTTPリクエストを行う前に実行されるJavaScriptコードです。Postmanで利用できるJavaScriptの関数やライブラリのサポートも含まれます。

📘

フローレベルのスクリプト設定

APIテストのすべてのリクエストに同一のリクエスト前実行スクリプトを適用するには、APIテストエディターのフローレベルの設定モーダルウィンドウを開き、[PRE-REQUEST] タブをクリックします。

SETTINGS

HTTPリクエストに適用されるキー名(Key)と値(Value)のペアの設定です。

リダイレクトの無効化

HTTPレスポンスコード3xxのリダイレクトを無効化する場合は、[SETTINGS] タブで [Key] にfollowRedirects、[Value] にfalseと入力して [add] をクリックします。

610

[SETTINGS] タブでリダイレクトを無効化