EchoAPI チュートリアル: EchoAPI でスクリプトを使用する方法

このチュートリアルでは、高度な API テストと開発のために EchoAPI のスクリプトを利用する方法を検討します。 JavaScript で書かれた EchoAPI スクリプトを使用すると、API リクエストに動的な機能を追加できます。実行前スクリプトと実行後スクリプトの両方を理解することで、テスト機能を強化し、変数を管理し、リクエスト パラメーターを簡単に操作できます。 EchoAPI スクリプトの強力な機能を詳しく見て、API ワークフローをどのように合理化できるかを見てみましょう。

EchoAPIスクリプトとは何ですか?

EchoAPI スクリプトは、API リクエストまたはコレクション テスト中に動的な動作を追加できる JavaScript に基づくコード スニペットです。

EchoAPIスクリプトの機能

スクリプトは次の機能を実現できます:

• リクエスト応答結果 (実行後スクリプト) の正しさをテスト (アサート) します。
• API 署名パラメーター (実行前スクリプト) の追加など、API リクエスト パラメーターを動的に変更します。
• API リクエスト間でデータを受け渡します (スクリプト内の変数を使用します)。
• スクリプト内で API エンドポイントに直接リクエストを行います。

EchoAPI スクリプトは、実行前スクリプトと実行後スクリプトに分かれています。

実行前スクリプト

実行前スクリプトは、リクエストが送信される前に実行されます。

実行後スクリプト

実行後スクリプトは、リクエストの送信後に実行されます。

実際の提出例

以下の図 (コンソール出力) に示すように、実行前スクリプトはリクエストの送信前に実行され、実行後スクリプトはリクエストの完了後に実行されます。

実行前スクリプトの機能

実行前スクリプトにはいくつかの重要な機能があります:

• JS 関数を使用して複雑な計算を実行します。
• 変数の値を出力します。
• 環境変数を定義、取得、削除、クリアします。
• グローバル変数を定義、取得、削除、クリアします。
• リクエストパラメータにアクセスします。
• ヘッダー パラメーターを動的に追加または削除します。
• クエリパラメータを動的に追加または削除します。
• ボディパラメータを動的に追加または削除します。
• HTTP リクエストを送信します。

たとえば、実行前スクリプトで関数 _random を定義できます。

function _random() {
    return 'Hello, EchoAPI ' + Math.random();
}

この関数は、文字列「Hello, EchoAPI」とそれに続く乱数を返します。次に、次のようにグローバル変数random_varに割り当てることができます:

pm.globals.set("random_var", _random());

実行前スクリプトのデバッグ変数の出力

console.log() を使用すると、必要な変数をコンソールに出力し、それらの変数の現在の値を表示できます。

環境変数の管理

• 環境変数の設定:

  pm.variables.set("key", "value"); // Set an environment variable 'key' with value 'value'

• 環境変数の取得:

  pm.variables.get("key"); // Get the value of the environment variable 'key'

• 環境変数の削除:

  pm.variables.delete("key"); // Delete the environment variable 'key'

• すべての環境変数をクリアします:

  pm.variables.clear(); // Clear all defined environment variables

グローバル変数の管理

• グローバル変数の設定:

  pm.globals.set("key", "value"); // Set a global variable 'key' with value 'value'

• グローバル変数の取得:

  pm.globals.get("key"); // Get the value of the global variable 'key'

• グローバル変数の削除:

  pm.globals.delete("key"); // Delete the global variable 'key'

• すべてのグローバル変数をクリアします:

  pm.globals.clear(); // Clear all defined global variables

リクエストパラメータへのアクセス

リクエスト パラメータには、リクエスト オブジェクトを通じてアクセスできます。詳細については、「EchoAPI 組み込み変数」セクションを参照してください。

リクエストパラメータの動的管理

• ヘッダーパラメータの追加:

  pm.setRequestHeader("key", "value"); // Dynamically add a header parameter with key 'key' and value 'value'

• ヘッダーパラメータの削除:

  pm.removeRequestHeader("key"); // Remove the header parameter with key 'key'

• クエリパラメータの追加:

  pm.setRequestQuery("key", "value"); // Dynamically add a query parameter

• クエリパラメータの削除:

  pm.removeRequestQuery("key"); // Remove the query parameter with key 'key'

• ボディパラメータの追加:

  pm.setRequestBody("key", "value"); // Dynamically add a body parameter

• ボディパラメータの削除:

  pm.removeRequestBody("key"); // Remove the body parameter with key 'key'

実行前スクリプトでの HTTP リクエストの送信

実行前スクリプトで AJAX の $.ajax() メソッドを使用して HTTP リクエストを送信できます。以下は、リクエストが https://echo.apipost.cn/get.php に送信され、レスポンスの bigint がグローバル変数 bigint に割り当てられる簡単な例です。

function _random() {
    return 'Hello, EchoAPI ' + Math.random();
}

実行後スクリプトの機能

実行後スクリプトはリクエストの送信後に実行され、次のような実行前スクリプトと同じ機能の多くを実行できます。

• JS 関数を使用して複雑な計算を実行します。
• 変数の値を出力します。
• 環境変数を定義、取得、削除、クリアします。
• グローバル変数を定義、取得、削除、クリアします。
• リクエストおよびレスポンスのパラメータにアクセスします。
• HTTP リクエストを送信します。
• リクエスト応答結果の正しさをテスト (アサート) します。

環境変数とグローバル変数を定義、取得、削除、クリアする方法は、実行前スクリプトの方法と同じであるため、ここでは繰り返しません。

応答パラメータの受信

応答オブジェクトを介して応答パラメータにアクセスできます。詳細な操作については、「EchoAPI 組み込み変数」セクションを参照してください。

要求応答の有効性のテスト

実行後スクリプトを使用して、リクエスト応答結果の正確さをテスト (アサート) できます。

結論

要約すると、EchoAPI スクリプトは、API のテストおよび開発プロセスを強化するための強力な方法を提供します。実行前スクリプトと実行後スクリプトの両方を活用することで、リクエスト パラメータを動的に管理し、レスポンスの有効性を主張し、変数を効果的に利用できます。この機能により、テスト プロセスが合理化されるだけでなく、より複雑な操作も可能になり、API 統合の精度と効率を確保しやすくなります。今すぐ EchoAPI スクリプトの実装を開始して、API テストのエクスペリエンスを向上させましょう!

以上がEchoAPI チュートリアル: EchoAPI でスクリプトを使用する方法の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。