More than 3 years have passed since last update.

postmanの使い方(メモ)

Posted at 2021-05-08

#POSTMANのインストール

下記のリンクあるいは検索エンジンでpostmanのダウンロードを検索し、インストーラーをダウンロードをします。
https://www.postman.com/downloads/

#URLの呼び出し

左側にある「Collections」の項目を選択し、「New」のアイコンをクリックします。
「Create New」の画面が表示され、「Collection」をクリックします。
新規のCollectionが作成され、Collectionの名前を決めます。
※Collectionの名前はCollectionを右クリックで、あとで再度変更することができます。
作成したCollectionを展開し、「Add a request」をクリックするとCollectionにリクエストが追加されます。
新規のRequestが作成され、Requestの名前を決めます。
※Requestの名前はRequestを右クリックで、あとで再度変更することができます。
呼び出したいURLを入力し、「Send」のボタンをクリックします。
※ここでGETのリクエストメソッドを使用します。GETの項目をクリックするとPOSTやDELETEなどのリクエストメソッドを選択できます。
下記の画面のように呼び出したいURLからレスポンスが返ってきます。
※ここでレスポンスコード、レスポンスボディ、レスポンスの時間などの情報を確認できます。
作成したリクエストが問題なければ、「Save」のボタンをクリックし、リクエストを保存します。

#Collection内のリクエストの実行
Collectionに複数のリクエストが存在する場合、個々のリクエストを手動実行することが可能ですが、まとめて実行することができます。

全リクエストを実行したいCollectionを選択し、「Run」の項目をクリックします。
Runnerの画面が表示され、実行したいリクエストを選択できます。ここでコレクションの実行回数とリクエストが実行される前の遅延時間も設定できます。「Run New Collection」のボタンをクリックします。
※実行したくないリクエストがある場合、そのリクエストのチェックを外します。
Collectionのリクエストの実行結果は下記のようになります。実行した結果をファイルとして出力したい場合に、「Export Results」のボタンをクリックします。
・View Summaryの画面

・View Resultの画面

#Collection内のリクエストの実行(Newmanを使用)

npm install -g newman

実行したいCollectionを右クリックし、「Export」をクリックします。
「EXPORT COLLECTION」の画面が表示され、「Export」ボタンをクリックします。ファイルを保存する場所の画面が現れたら、ファイルを置きたい場所を決めて「Save」ボタンをクリックします。
※ファイル名は「コレクション名」.postman_collection.jsonになります。この例ではNew Collection.postman_collection.jsonとなります。

4)コマンドプロンプトを起動し、下記のコマンドを実行します。

newman run 「コレクション名」.postman_collection.json

※この例ではコマンドがnewman run "New Collection.postman_collection.json"となります。

コマンドの実行結果は下記のようになります。
※ここでリクエストの実行が成功か失敗したかを確認できます。またリクエストに対するテストを設定した場合にそのテストが成功か失敗したかを確認できます。

#postmanでよく使用する関数
上記の「URLの呼び出し」で作成したRequest内の「Pre-request Script」と「Tests」のタブに下記の関数をよく使用しました。

##環境変数にキーと値をセットする

pm.environment.set("キー名","値");

##環境変数から値を取得する

pm.environment.get("キー名");

##レスポンスコードの確認

pm.response.to.have.status(200);

##レスポンスヘッダの確認

pm.response.to.have.header('Accept');

##レスポンスボディの確認

pm.expect(pm.response.text()).to.include('Apple');

##レスポンスの評価の実施

pm.test("テスト名", function () {
    var jsonData = pm.response.json();
    pm.expect(jsonData.value).to.eql(50);
});

##リクエストの遅延実行(Requestの「Pre-request Script」内に設定する)

setTimeout(function(){}, 60000);

※時間の単位はmsとなります。