前・後処理機能の紹介
前処理と後処理は、APIリクエストの送信と応答中に実行されるスクリプトです。主に、API リクエストを開始する前と応答を取得した後に検証を完了したり、特定の操作を実行したりするために使用されます。目的は、API のデバッグとテストを改善することです。 、APIの正確性を確保するため。
前処理
前処理は、APIリクエストの前に実行されるスクリプトであり、次のことを行うために使用できます。
- API Header（リクエストヘッダ）の設定
これらは、リクエストヘッダー、リクエストBodyの設定、リクエストパラメータの検証、認証の構成などに使用できます。
- APIパラメータを設定する
事前操作では、環境変数、グローバル変数、およびリクエスト変数のデータにアクセスできます。 前処理は、ユーザーがリクエスト パラメータとその処理方法を理解するのにも役立ちます。
- API認証（Auth）をかける
たとえば、Basic 認証やOAuth などです。 APIリクエストを送信する前に、前処理を使用してアクセストークンまたはその他の権限を取得し、送信された API リクエストが有効かつ合法的なリクエストであることを確認できます。
変数置換
「変数置換」機能は通常、API リクエストを送信する前に、インターフェースのリクエストパラメータで参照されているすべての変数 (動的値を含む) を実際のリクエストの内容に置き換えるのに使用されます。 通常、インターフェイス署名などの変換シナリオを処理するために使用されます。 現時点では、主に次の 2 つのシナリオが関係します。
スクリプト経由で変数を設定する
このシナリオの操作は、「変数置換」の前に実行する必要があります。そうしないと、スクリプトを通じて設定された変数が現在のAPIのリクエストパラメーターに反映されません。
API署名スクリプト
このシナリオでは、APIから実際に要求されたパラメータ値をスクリプトが取得できるように、「変数置換」の後にスクリプトを配置する必要があります。そうしないと、取得されたパラメータ値は変数置換前のテンプレート データになります。
後処理
後処理では、ステータスコード、ヘッダー、Body、その他の情報など、APIの応答から取得したデータを二次処理に使用できます。
APIレスポンスのステータス コードと応答時間が予想どおりであるかを確認します。
JSON データや XML データなどの API 応答のコンテンツを検証します。
APIレスポンスからデータを抽出し、後続のリクエストで使用します。
レスポンスに必要なデータを自動的に抽出します。
子孫関係
前・後処理は両方とも、APIディレクトリに親アクションを設定できます。 親レベルの操作は、このディレクトリ内のすべてのAPIに継承できます。これは、Authや変数置換など、同じ前処理を複数のインターフェイスで実行する必要があるシナリオに適しています。 API自体は、各操作の実行順を柔軟に調整できます。
子APIは、親のアクションを取るかどうかを選択できます。
子APIの下に複数のユースケースがある場合、子孫関係を無効にすると、その下のケースもこの前処理を継承しません。
