リクエスト設定

APIチェックのリクエスト設定

リクエスト設定とは？

リクエスト設定は、テストしたいAPIエンドポイントの詳細を定義する場所です。URL、HTTPメソッド、およびリクエストに必要な追加パラメータやヘッダーの設定が含まれます。

リクエストの設定

1. URLエンドポイント：テストしたいAPIエンドポイントのURLを設定します。これはチェックがリクエストを送信するアドレスです。
2. HTTPメソッド：APIエンドポイントがサポートする以下の許可されたHTTPメソッドから選択します：

• GET：サーバーからデータを取得します。
• POST：サーバーにデータを送信してリソースを作成/更新します。
• PUT：サーバー上の既存のリソースを更新します。
• PATCH：サーバー上の既存のリソースを部分的に更新します。
• DELETE：サーバーからリソースを削除します。

追加のリクエスト設定

以下のオプションでAPIチェックをさらにカスタマイズできます：

• クエリパラメータ：URLに追加するキー/値ペアを追加します。URLを通じて追加データを渡すことができます。

  • 例：https://api.example.com/resource?key1=value1&key2=value2

• ヘッダー：リクエストにカスタムヘッダーを追加します。ヘッダーはメタデータの送信やリクエストの処理方法の制御に使用できます。

  • 例：Content-Type: application/json

• POSTボディ：POSTリクエストにボディを含めます。リソースの作成や更新のためにデータを送信する際に便利です。

  • 例：{"name": "example", "value": "data"}

• Basic認証：Basic認証の資格情報を提供します。サーバーとのリクエストの認証に使用されます。

  • 例：Username: user, Password: pass

• SSL検証のスキップ：SSL検証をスキップするオプションです。自己署名証明書を使用するエンドポイントのテスト時に便利です。

  • 例：Skip SSL: true

• リダイレクトのフォロー：HTTPリダイレクトをフォローするオプションです。チェックがサーバーからのリダイレクトレスポンスに従うことを保証します。

  • 例：Follow Redirects: true

実用的なユースケース

• GETリクエストのテスト：APIが正しくデータを取得しているか確認します。
• POSTリクエストのテスト：APIがデータの作成や更新を処理できるか確認します。
• 認証用ヘッダーの使用：保護されたリソースにアクセスするために、ヘッダーに認証トークンを渡します。
• 複雑なクエリパラメータの送信：APIが複雑なクエリをどのように処理するかテストします。

これらの設定を構成することで、APIエンドポイントの正確な要件に合わせてAPIチェックをカスタマイズし、包括的なテストとモニタリングを確保できます。