Scriptの概要
Apidogには、JavascriptベースのScriptエンジンが内蔵されています。Script(JavaScriptコードスニペット)を使用して、API Requestまたはコレクションテストに動的動作を追加できます。
Scirptで次のことが実現:
- Requestが返したResponseの正確性をテスト (アサート) する。(後処理Script)
- API署名パラメータの追加など、API Requestのパラメータを動的に変更する。(前処理Script)
- API Request 間でデータを渡す。(Scriptを使用して変数を編集する)
- 他の言語で書かれたプログラムを直接呼び出す。java(.jar)、Python、PHP、JavaScript、BeanShell、Go、Shell、Swift、Ruby、Luaなどをサポートしています。
ご注意:
ApidogのScript 構文は、Postmanと完璧な互換性があります。PostmanのScriptをApidogにシームレスに移行できます。
使い方:
Scriptsは次の2つの段階で追加されます。
- Requestをサーバーに送信する前に、前処理Scriptを使用します。
- Responseを受信した後、後処理Script(アサーション)を使用します。
グローバルScriptとグループScript
- プロジェクトのルートフォルダーで設定した前処理と後処理は、当該プロジェクトのいずれかのAPIを実行しても、有効になります。
- プロジェクトのグループで設定した前処理と後処理は、当該グループにあるAPIを実行する時に有効です。
API Requestの実行順序は次のとおりです:
グローバル前処理Script -> グループの前処理Script -> APIの前処理Script -> API requestの送信 -> Responseの返し -> グローバル後処理Script -> グループの後処理Script -> APIの後処理Script
デバッグのScript
前処理と後処理でデバッグのScriptを書くことができ、console.log("message")
を通じて出力情報を記録できます。そして、コントロールを開いて確認できます。