概要 - Apidog Docs

プリプロセッサーおよびポストプロセッサーは、Apidog の主要な機能です。リクエストを送信する際、プリプロセッサーを使用してリクエストを動的に制御したり、ポストプロセッサーを使用して受信したレスポンスを処理したりできます。

Apidog は、従来のスクリプトベースのアプローチを補完する、プリリクエストおよびポストリクエスト操作向けの視覚的なドラッグ＆ドロップインターフェースを提供します。この視覚的なインターフェースにより、コードを書かずに一般的な操作を設定できる一方で、高度なユースケース向けのカスタムスクリプトにも対応しています。

クイックスタート

Apidog でプリプロセッサーおよびポストプロセッサーを使用する手順は次のとおりです。

任意のエンドポイントを開き、Run タブ（Design-first Mode）または Request タブ（Request-first mode）に移動します。

Design-first Mode

Request-first Mode

Pre Processors または Post Processors セクションに切り替え、+ Add にカーソルを合わせて、目的のプロセッサーを選択します。

追加したプロセッサーに必要なフィールドを入力します。

Send をクリックすると、設定済みのプリ／ポストプロセッサーを使用してリクエストが実行されます。

Design-first Mode では、Save as case をクリックしてリクエストを保存します。Request-first Mode では、Save または Save as case をクリックしてリクエストを保存します。

Design-first Mode

Request-first Mode

TIP

スタンドアロンのリクエストを作成し、それにプリ／ポストプロセッサーを適用することもできます。ただし、デバッグとテストをより効率化するために、エンドポイント仕様の上でプリ／ポストプロセッサーを活用することを推奨します。

機能

プリプロセッサーおよびポストプロセッサーを組み合わせることで、さまざまな機能を実現できます。

プリプロセッサー

リクエストパラメータの設定: API エンドポイントの入力データを動的に定義します。

ヘッダー設定: Content-Type、Accept、Authorization などのヘッダーを指定します。

認証: 保護されたエンドポイント用に、トークン、API キー、または認証情報を追加します。

データベース連携: リクエストパラメータとして使用する値をデータベースから取得します。

暗号化: 送信前にリクエストペイロードを保護します。

ポストプロセッサー

アサーション: 受信したレスポンスを期待される結果（ステータスコード、ボディ内容など）と照合して検証します。

変数抽出: 後続のリクエストで使用するために、レスポンスから値を抽出します。

データベース操作: 保存または更新のために、レスポンスデータをデータベースに書き込みます。

データ可視化: レスポンスデータのレポートまたは視覚的表現を生成します。

TIP

一部のプリ操作およびポスト操作では、データベースへのアクセス、外部プログラムの呼び出し、または npm パッケージの動的ロード時に、セキュリティ認可プロンプトが表示される場合があります。Security 設定に移動して、これらの認可範囲を事前に設定できます。

利用可能なプロセッサー

Apidog は、次のプリ／ポストプロセッサーに対応しています。

プロセッサー	種類	説明
Assertion	Post	レスポンスデータを期待値（ステータスコード、ボディ、ヘッダー）と照合するための検証ルールを定義します。
Extract Variable	Post	レスポンス（JSON、XML、Text）から値を抽出し、JSONPath または XPath を使用して変数として保存します。
Database Operation	Pre/Post	SQL/NoSQL データベースに接続してクエリを実行します。結果は変数として保存できます。
Custom Scripts	Pre/Post	複雑なロジックを処理するためのカスタム JavaScript コードを記述します。リクエスト／レスポンスデータおよび環境変数にアクセスできます。
Public Scripts	Pre/Post	複数のプロセッサーまたはシナリオで共有される再利用可能なスクリプトスニペットを作成します。
Wait	Pre/Post	リクエストの前後に遅延を導入します。実際の環境に近いレイテンシをシミュレートする場合に便利です。

スクリプト作成を簡略化するために、Apidog Script Generator の使用を推奨します。自然言語でロジックを説明すると、ジェネレーターが実行可能なスクリプトを作成します。

実行順序

プリプロセッサーおよびポストプロセッサーは、複数のレベルで設定できます。

Run/Endpoint Case レベル（デフォルト）: 現在の実行／ケースにのみ影響します。

Endpoint レベル: エンドポイントに関連付けられたすべてのケースに適用されます。

Folder レベル: フォルダー内のすべてのエンドポイントに影響します。

Project レベル: プロジェクト内のすべてのリクエストに適用されます（最上位のスコープ）。

実行フローは、最上位レベル（Project/Folder）から特定の Run/Case レベルへと進みます。

実行の可視化

リクエスト内のプリプロセッサーのセットは、次のように表示される場合があります。

上のスクリーンショットでは、次のようになっています。

最初の 3 つのプロセッサーは、Inherit from parent の下にグループ化されています。これらは Root フォルダー、特定のフォルダー（例: 「Pets」）、またはエンドポイント自体で定義されています。

これらの継承されたプロセッサーは、現在の実行では読み取り専用ですが、オン／オフを切り替えることができます。

最後のプロセッサーは、この実行専用に追加されたカスタムスクリプトであり、直接編集できます。

変数置換

Variable Substitution & Inherit from Parents というステップに気付く場合があります。この特別なプリプロセッサーは、{{variable}} のようなプレースホルダーを実際の値に置き換えます。

デフォルト動作: ほとんどのプリプロセッサーは、変数置換の前に実行されます。

置換後: 一部のスクリプト（例: API 署名）は、変数が置き換えられた後に実行する必要があります。これらのプロセッサーを「Variable Substitution」ステップの下に手動でドラッグできます。

完全な実行フロー

単一リクエストの詳細な実行順序は、次のとおりです。

概要

クイックスタート#

機能#

プリプロセッサー#

ポストプロセッサー#

利用可能なプロセッサー#

実行順序#

実行の可視化#

変数置換#

完全な実行フロー#