メインコンテンツまでスキップ

共通Script

共通Scriptは、Scriptを再利用し、異なる場所で同じScriptの繰り返し設定を回避するように設計されています。

同じメソッドとクラスのScriptを共通Scriptに配置し、API Requestで共通Scriptを参照して直接使用できます。

使い方​

共通Scriptの管理​

プロジェクトの設定 -> 共通Scriptで共通Scriptを管理できます。

apidog

共通Scriptの参照​

APIの実行ページ、またはAPIケースページで、前処理と後処理から共通Scriptを直接参照できます。

apidog

ご注意：
  • 共通Scriptは、他のタイプのScriptよりも先に実行されます。
  • 複数の共通Scriptの実行順は、Script 追加と同じ順序になります。

他のScriptが共通Scriptを参照​

Scriptは互いに呼び出し合えます。例えば:

  • 通常のScriptが共通Script 内の変数または通信方式を呼び出す必要がある場合は、pm.sendRequestやpm.environments.setなどのタイプのAPIを使用しないでください。単純な関数を書いて、Returnを通して返すことをお勧めします。
  • 共通Scriptは互いに呼び出し合うことができます。
  • 後処理Scriptは前処理Scriptを呼び出すことができます。

Script 間の変数衝突を防ぐために、すべてのScriptは、独自のスコープ内で実行されます。ローカル変数またはローカルメソッドがvar、let、const、または関数で宣言されている場合、他のScriptはそれらの変数またはメソッドを呼び出すことはできません。他のScriptで使用する場合は、変数またはメソッドをグローバル変数またはグローバルメソッドに変換する必要があります。

変数の例：

// Declare a local variable, which cannot be used by other scripts.
var my_var = "hello"；

お勧め：

// Declare a global variable, which can be used by other scripts.
my_var = "hello";

関数の例：

// Declare a local function, which cannot be used by other scripts.
function my_fun(name) {
  console.log("hello" + name);
}

お勧め：

// Declare a global function, which can be used by other scripts.
my_fun = function(name) {
  console.log("hello" + name);
};
ご注意：
  • 異なるScript 間のグローバル変数またはグローバルメソッドの名前に衝突がないことを確認する必要があります。
  • APIケースでは、共通Scriptを使用するために前処理または後処理Scriptでそれを追加する必要があります。
  • Scriptを参照するときは、呼び出しの順序に注意を払う必要があります。後で実行されたScriptが、先に実行されたScriptを呼び出すことができます。