Postman チュートリアル
トーマス・ハミルトン
🚀 スマートサマリー
Postman は、開発環境とテスト環境における効率的なAPIワークフロー管理のために設計されたスケーラブルなAPIテストツールです。組織化、コラボレーション、自動化を合理化し、重要なAPIテストタスクへのアクセスと繰り返しを可能にします。
何ですか Postman?
Postman CI/CDパイプラインに迅速に統合できるスケーラブルなAPIテストツールです。2012年にAbhinav Asthana氏によるサイドプロジェクトとして開始され、テストと開発におけるAPIワークフローを簡素化することを目指しています。APIはApplication Programming Interface（アプリケーションプログラミングインターフェース）の略で、ソフトウェアアプリケーションがAPI呼び出しを介して相互に通信することを可能にします。
👉 無料のライブ API テスト プロジェクトに登録する
なぜ使うの？ Postman?
現在 4 万人を超えるユーザーがおり、 Postman ソフトウェアが選ばれるツールとなった理由は、次のとおりです。
- アクセシビリティ – Postman ツールを使えば、自分のアカウントにログインするだけで、いつでもどこでもファイルに簡単にアクセスできます。 Postman アプリケーションがコンピュータにインストールされている。
- コレクションの使用 – Postman ユーザーが自分のコレクションを作成できるようにします Postman API呼び出し。各コレクションはサブフォルダと複数のリクエストを作成できます。これにより、テストスイートを整理しやすくなります。
- コラボレーション – コレクションと環境をインポートまたはエクスポートできるため、ファイルの共有が簡単になります。直接リンクを使用してコレクションを共有することもできます。
- 環境の作成 – 複数の環境を用意することで、同じコレクションを異なる環境で使用できるため、テストの繰り返し回数を減らすことができます。ここでパラメータ化が行われますが、これについては後のレッスンで説明します。
- テストの作成 – HTTPレスポンスステータスの成功の検証などのテストチェックポイントを各テストに追加できます。 Postman API呼び出しは、 テストカバレッジ.
- 自動テスト – Collection Runner または Newman を使用すると、テストを複数の反復で実行できるため、繰り返しテストにかかる時間を節約できます。
- デバッグ – Postman コンソールを使用すると、取得されたデータを確認し、テストのデバッグが容易になります。
- 継続的インテグレーション – 継続的統合をサポートする機能により、開発慣行が維持されます。
使用方法 Postman APIを実行するため
以下は Postman ワークスペース。ステップバイステップのプロセスを見てみましょう。 使用方法 Postman のさまざまな機能 Postman ツール！
- 新規 – ここで、新しいリクエスト、コレクション、または環境を作成します。
- インポート – コレクションまたは環境をインポートするために使用されます。ファイル、フォルダー、リンクからのインポート、生のテキストの貼り付けなどのオプションがあります。
- ランナー – 自動化テストはコレクション ランナーを通じて実行できます。 これについては、次のレッスンでさらに詳しく説明します。
- 新規を開く – 新しいタブを開きます。 Postman このボタンをクリックして、ウィンドウまたはランナー ウィンドウを開きます。
- マイ ワークスペース – 新しいワークスペースを個人またはチームとして作成できます。
- 招待 – チームメンバーを招待して、ワークスペースで共同作業します。
- 履歴 – 過去に送信したリクエストは履歴に表示されます。これにより、実行したアクションを簡単に追跡できます。
- コレクション – コレクションを作成してテストスイートを整理します。各コレクションにはサブフォルダと複数のリクエストを含めることができます。リクエストまたはフォルダは複製することもできます。
- リクエスト タブ – 作業中のリクエストのタイトルが表示されます。デフォルトでは、タイトルのないリクエストには「無題のリクエスト」が表示されます。
- HTTPリクエスト - これをクリックすると、GET、POST、COPY、DELETEなどのさまざまなリクエストのドロップダウンリストが表示されます。 Postman API テストで最も一般的に使用されるリクエストは GET と POST です。
- リクエスト URL – エンドポイントとも呼ばれ、API が通信するリンクを識別する場所です。
- 保存 – リクエストに変更がある場合は、新しい変更が失われたり上書きされたりしないように、[保存] をクリックする必要があります。
- Params – キー値など、リクエストに必要なパラメータを記述する場所です。
- 認可 – APIにアクセスするには、適切な認可が必要です。認可には、ユーザー名とパスワード、ベアラートークンなどが用いられます。
- ヘッダー – 組織のニーズに応じて、コンテンツ タイプ JSON などのヘッダーを設定できます。
- 本文 – ここではリクエストの詳細をカスタマイズできます。通常は POST リクエストで使用されます。
- リクエスト前スクリプト – これらはリクエストの前に実行されるスクリプトです。 通常、設定環境の事前リクエスト スクリプトは、テストが正しい環境で実行されることを保証するために使用されます。
- テスト – リクエスト中に実行されるスクリプトです。レスポンスステータスが正常かどうか、取得されたデータが期待どおりかどうか、その他のテストを検証するためのチェックポイントを設定するため、テストは重要です。
GET リクエストの操作
GETリクエストは、指定されたURLから情報を取得するために使用されます。エンドポイントには変更は加えられません。
この例ではすべて次のURLを使用します。 Postman チュートリアル https://jsonplaceholder.typicode.com/users
ワークスペースで
- HTTP リクエストを GET に設定します。
- リクエストURLフィールドにリンクを入力します
- 送信をクリック
- 「200 OK」メッセージが表示されます
- 本文には 10 件のユーザー結果が含まれているはずです。これは、テストが正常に実行されたことを示します。
*注意： Getが Postman リクエストが失敗した可能性があります。リクエストURLが無効であるか、認証が必要である可能性があります。
POSTリクエストの操作
POSTリクエストは、ユーザーがエンドポイントにデータを追加するというデータ操作を伴うため、GETリクエストとは異なります。前回のチュートリアルでGETリクエストで使用したのと同じデータを使用して、独自のユーザーを追加してみましょう。
ステップ1） 新しいタブをクリックして新しいリクエストを作成します。
ステップ2） 新しいタブで
- HTTP リクエストを POST に設定します。
- リクエスト URL に同じリンクを入力します。 https://jsonplaceholder.typicode.com/users
- 「本文」タブに切り替えます
ステップ3） ボディでは、
- 「生」をクリックします
- JSONを選択
ステップ4） 以下のように、前の get リクエストから 11 つのユーザー結果をコピーして貼り付けます。コードが中括弧と角括弧のペアで正しくコピーされていることを確認します。id を XNUMX に変更し、name を任意の名前に変更します。アドレスなどの他の詳細を変更することもできます。
[
{
"id": 11,
"name": "Krishna Rungta",
"username": "Bret",
"email": "[email protected]",
"address": {
"street": "Kulas Light",
"suite": "Apt. 556",
"city": "Gwenborough",
"zipcode": "92998-3874",
"geo": {
"lat": "-37.3159",
"lng": "81.1496"
}
},
"phone": "1-770-736-8031 x56442",
"website": "hildegard.org",
"company": {
"name": "Romaguera-Crona",
"catchPhrase": "Multi-layered client-server neural-net",
"bs": "harness real-time e-markets"
}
}
]
*注意： 要求されたデータが確実に作成されるように、オンラインPOSTリクエストは正しい形式である必要があります。まずGetを使用してリクエストのJSON形式を確認することをお勧めします。以下のツールも利用できます。 https://jsonformatter.curiousconcept.com/
ステップ5） 次に、
- 送信をクリックします。
- ステータス: 201 作成済みと表示される
- 投稿されたデータが本文に表示されます。
リクエストをパラメータ化する方法
データのパラメータ化は、の最も便利な機能の 1 つです。 Postman異なるデータで同じリクエストを作成する代わりに、パラメータ付きの変数を使用できます。これらのデータは、データファイルまたは環境変数から取得できます。パラメータ化により、同じテストの繰り返しを回避でき、反復処理を次のように使用できます。 自動化テスト.
パラメータは二重中括弧を使用して作成されます: {{sample}}。前のリクエストでパラメータを使用する例を見てみましょう。
次に、パラメータ化された GET リクエストを作成しましょう。
ステップ1）
- HTTP リクエストを GET に設定します
- このリンクを入力してください: https://jsonplaceholder.typicode.com/users。 リンクの最初の部分を {{url}} などのパラメータに置き換えます。 リクエスト URL は {{url}}/users になるはずです。
- 送信をクリックします。
パラメータのソースを設定していないため、応答はありません。
ステップ2） パラメータを使用するには環境を設定する必要があります
- 目のアイコンをクリックします
- 編集をクリックすると、変数がすべてのコレクションで使用できるグローバル環境設定されます。
ステップ3） 変数では、
- 名前を https://jsonplaceholder.typicode.com の URL に設定します。
- 「保存」をクリックします。
ステップ4） 次の画面が表示された場合は、「閉じる」をクリックします
ステップ5） GETリクエストに戻り、「送信」をクリックしてください。リクエストの結果が表示されるはずです。
*注意： エラーを回避するために、パラメータに環境変数やデータ ファイルなどのソースがあることを常に確認してください。
作り方 Postman テスト
Postman テストは Javaリクエストに追加されるスクリプトコード。成功または失敗のステータス、期待される結果の比較など、結果の検証に役立ちます。通常はpm.testで始まります。他のツールで利用可能なassertsコマンドやverifyコマンドに相当します。
基本的なことをやってみましょう APIテスト Postman 前回のレッスンのパラメータ化されたリクエスト用です。
ステップ1） 前のチュートリアルの GET ユーザー リクエストに移動します。
- 「テスト」タブに切り替えます。 右側にはスニペットコードが表示されます。
- スニペットセクションから、「ステータスコード: コードは 200」をクリックします。
ペインには自動入力されます
ステップ2） 次に、[送信] をクリックします。テスト結果が表示されます。
ステップ3） [テスト] タブに戻って、別のテストを追加しましょう。 今回は、期待される結果と実際の結果を比較してみます。
スニペットセクションから、「Response body:JSON value check」をクリックします。 Leanne Graham がユーザー ID 1 を持っているかどうかを確認します。
ステップ4）
- コードの「Your Test Name」を「Check if user with id1 is Leanne Graham」に置き換えて、テスト名がテスト対象を正確に指定できるようにします。
- jsonData.value を jsonData[0].name に置き換えます。パスを取得するには、先ほどの「結果を取得」の本体を確認してください。Leanne Graham のユーザーIDは 1 なので、jsonData は最初の結果に含まれており、これは 0 から始まるはずです。2番目の結果を取得したい場合は jsonData[1] を使用し、それ以降の結果も同様に使用します。
- eql に「Leanne Graham」と入力します。
pm.test("Check if user with id1 is Leanne Graham", function () {
var jsonData = pm.response.json();
pm.expect(jsonData[0].name).to.eql("Leanne Graham");
});
ステップ5） 「送信」をクリックします。 これで、リクエストに対して XNUMX つの合格したテスト結果が得られるはずです。
*注意： で作成できるさまざまな種類のテストがあります Postman。ツールを試して、どのようなテストがニーズに合うかを確認してください。
コレクションの作成方法
コレクションはテストスイートを整理する上で重要な役割を果たします。コレクションはインポートとエクスポートが可能なので、チーム内で簡単に共有できます。このチュートリアルでは、コレクションの作成と実行方法を学びます。
コレクションの作成を始めましょう。
ステップ1） ページの左上隅にある「新規」ボタンをクリックします。
ステップ2） 「コレクション」を選択します。 コレクションの作成ウィンドウが表示されます。
ステップ3） 目的のコレクション名と説明を入力し、「作成」をクリックします。 これでコレクションが作成されるはずです。
ステップ4） 前の Get リクエストに戻ります。 「保存」をクリックします
ステップ5）
- 選択する Postman テストコレクション。
- [保存先]をクリックします Postman テストコレクション
ステップ6） Postman テスト コレクションには 1 つのリクエストが含まれるようになりました。
ステップ7） 前の Post リクエストに対して手順 4 ～ 5 を繰り返して、コレクションに 2 つのリクエストが含まれるようにします。
Collection Runner を使用してコレクションを実行する方法
コレクションを実行するには、Collection Runner と Newman の XNUMX つの方法があります。 まず、Collection Runner でコレクションを実行します。
ステップ1） ページ上部の「インポート」ボタンの隣にある「ランナー」ボタンをクリックします。
ステップ2） コレクションランナーページは以下のように表示されます。以下は各フィールドの説明です。
ステップ3） 実行する Postman 以下を設定してコレクションをテストします。
- 選択する Postman テストコレクション - 反復を 3 に設定します
- 遅延を 2500 ミリ秒に設定します
- 「実行」をクリックします Postman テスト…ボタン
ステップ4） [実行] ボタンをクリックすると、[実行結果] ページが表示されます。遅延に応じて、実行中のテストが表示されます。
- テストが完了すると、テストのステータスが合格か失敗か、および反復ごとの結果を確認できます。
- Get リクエストの Pass ステータスが表示されます
- Post にはテストがなかったので、リクエストにテストがなかったというメッセージが表示されるはずです。
HTTP リクエストのステータスが成功し、データが作成または取得されたかどうかを確認できるように、リクエストにテストを含めることがいかに重要であるかがわかります。
Newman を使用してコレクションを実行する方法
コレクションを実行するもう 1 つの方法は、Newman を使用することです。Newman と Collection Runner の主な違いは次のとおりです。
- Newman は次のアドオンです Postman。ネイティブアプリとは別にインストールする必要があります。
- Newman はコマンド ラインを使用しますが、Collection Runner は GUI を備えています。
- Newman は継続的統合に使用できます。
Newman をインストールしてそこからコレクションを実行するには、次の手順を実行します。
ステップ1） このリンクを使用して、nodejs をインストールします。 http://nodejs.org/download/
ステップ2） コマンドラインを開いて次のように入力します
npm install -g newman
これで、Newman がコンピュータにインストールされるはずです。
ステップ3） Newman がインストールされたら、元のページに戻りましょう。 Postman ワークスペース。コレクション ボックスで、3 つのドットをクリックします。オプションが表示されます。エクスポートを選択します。
ステップ4） [コレクションをコレクション v2.1 (推奨) としてエクスポート] を選択し、[エクスポート] をクリックします。
ステップ5） 目的の場所を選択し、「保存」をクリックします。専用のフォルダーを作成することをお勧めします。 Postman テスト。これで、コレクションが選択したローカル ディレクトリにエクスポートされるはずです。
ステップ6） 環境をエクスポートする必要もあります。 「グローバル」の環境ドロップダウンの横にある目のアイコンをクリックし、「JSON としてダウンロード」を選択します。 目的の場所を選択し、「保存」をクリックします。 環境はコレクションと同じフォルダーに置くことをお勧めします。
ステップ7） 環境はコレクションと同じローカル ディレクトリにエクスポートされるはずです。
ステップ8） 次に、コマンド ラインに戻り、コレクションと環境を保存したディレクトリに変更します。
cd C:\Users\Asus\Desktop\Postman Tutorial
ステップ9） 次のコマンドを使用してコレクションを実行します。
newman run PostmanTestCollection.postman_collection.json -e Testing.postman_globals.json
実行結果が以下のように表示されるはずです。
ガイドには、実行のためのいくつかの基本的なニューマン コードへの参照があります。
- コレクションのみを実行します。 これは、環境やテスト データ ファイルの依存関係がない場合に使用できます。
- コレクションと環境を実行します。 -e インジケーターは環境用です。
- 希望の番号でコレクションを実行します。 反復の。
- データファイルを使用して実行します。
- 遅延時間を設定します。 前のリクエストがエンドポイント サーバー上で処理を完了しないままリクエストが開始されるため、遅延なくテストを実行すると失敗する可能性があるため、これは重要です。
newman run <collection name>
newman run <collection name> -e <environment name>
newman run <collection name> -n <no.of iterations>
newman run <collection name> --data <file name> -n <no.of iterations> -e <environment name>
newman run <collection name> -d <delay time>
当学校区の Postman 面接の質問ガイド 面接を突破し、ソフトウェア テストの夢の仕事を得るのに役立ちます。
コマンドと Postman トラブルシューティングのシナリオ
- 401 不正または 403 禁止エラー
これは、リクエストに有効な認証資格情報がない場合に発生します。
直し方： Double- 認証の種類（APIキー、ベアラートークン、またはBasic認証）を確認してください。トークンを使用している場合は、有効期限が切れていないことを確認してください。必要に応じて、新しいトークンを生成するか、セッション認証情報を更新してください。 - 400の間違ったリクエスト
リクエストの構文またはパラメータが正しくない場合、このエラーが発生します。
直し方： JSONLintなどのフォーマッタを使用して、JSONまたはXMLの本文を検証してください。パラメータがAPIの想定通りに設定されていることを確認してください（大文字と小文字の区別やデータ型など）。 - 500内部サーバーエラー
これは通常、バックエンドの問題ですが、ペイロードが適切に構造化されていない場合にも発生する可能性があります。
直し方： 有効なデータ形式でリクエストを再試行してください。 Revリクエストを再度送信する前に、適切なスキーマ定義については API ドキュメントを参照してください。 - リクエストタイムアウト（408）
サーバーの応答に時間がかかりすぎる場合に発生します。
直し方： インターネット接続を確認し、エンドポイントURLにアクセスできることを確認してください。送信するペイロードを小さくするか、タイムアウト設定を調整してください。 Postman 可能な場合は。 - 環境変数が機能しない
変数は定義されていないか、スコープが誤っている場合、適切に解決されない可能性があります。
直し方： 環境セレクターの横にある目のアイコンを開いて、定義されている変数を確認してください。正しい環境（グローバル、環境、またはコレクション）を使用していることを確認してください。 - 予期せず失敗するテスト
テスト スクリプトが期待どおりに動作しない場合は、多くの場合、ロジックまたは構文のエラーです。
直し方： console.log() を使用して中間結果を出力し、スクリプトをデバッグしてください。pm.response.json() を使用してレスポンスデータを正しく参照していることを確認してください。 - ヘッダーまたはコンテンツタイプが正しくありません
ヘッダーが間違っていると、サーバーの拒否やデータ不一致エラーが発生する可能性があります。
直し方： JSONデータを送信する際は、Content-Typeを常にapplication/jsonに指定してください。重複または競合するヘッダーを削除してください。 - コレクションランナーがテスト結果を表示しない
これは、テスト スクリプトに pm.test() ステートメントが含まれていない場合に発生します。
直し方： 次のような適切なテスト スクリプトを追加します。pm.test("Status code is 200", function () { pm.response.to.have.status(200); });これにより、Collection Runner がテスト結果をキャプチャして報告できるようになります。
- ニューマンはテストの実行に失敗する
Newman がエラーをスローする場合は、ファイル パスが正しくないか、バージョンが古いことが原因である可能性があります。
直し方： npm install -g newman を実行して Newman を更新します。コレクションと環境の .json ファイルが正しいパスに存在することを確認してください。 - 応答が遅い、またはリクエストが遅れている
ペイロードが重い場合やバックエンドの遅延が発生すると、テストが遅くなる可能性があります。
直し方： ページ区切りや小さなデータセットを使用します。 Postman 応答時間を測定し、遅いエンドポイントを識別するためのコンソール。
スムーズなベストプラクティス Postman テスト
1. 環境と変数を賢く使う
開発、QA、本番環境それぞれに専用の環境を構築できます。ベースURL、APIキー、トークンをハードコードするのではなく、変数に保存することで、環境間の切り替えをシームレスに行うことができます。
2. コレクションとワークスペースを整理する
コレクションをモジュール化しましょう。リクエストをAPIモジュールごとにグループ化しましょう。例えば、「ユーザー管理」、「認証」、「注文」などです。分かりやすいリクエスト名を付けることで、共同作業がスムーズになります。
3. コレクションのバージョン管理
コレクションを保存する Postman クラウドに保存するか、Gitにエクスポートします。これにより、バックアップ、バージョン追跡、そしてチームワークの円滑化が実現します。
4. 明確でわかりやすいテストを書く
テストのアサーションは読みやすく保ちましょう。例えば：
pm.test("Response time is below 200ms", function () {
pm.expect(pm.response.responseTime).to.be.below(200);
});
これにより、テストの読みやすさとデバッグの明確さが向上します。
5. 事前リクエストスクリプトで自動化する
事前リクエストスクリプトを使用すると、リクエストを実行する前にタイムスタンプを生成したり、署名を計算したり、トークンを動的に取得したりできます。これにより、手動による更新を最小限に抑えることができます。
6. APIを定期的に監視する
セットアップ Postman 定期的にテストを自動的に実行するモニター。APIが故障したりパフォーマンスが低下したりした場合にアラートを通知します。
7. 作業スペースを清潔に保つ
古くなった環境、変数、コレクションを削除します。整理されたワークスペースは、混乱や、非推奨のエンドポイントでの誤ったテスト実行を防ぎます。
8. 共通コードスニペットを再利用する
同じアサーションを繰り返し記述する代わりに、ヘッダー、本文チェック、応答検証用の再利用可能なスニペットを保存します。
9. Newmanを使用してCI/CDと統合する
Newmanを使用してJenkins、GitHub Actions、または Azure パイプライン。これにより、すべてのデプロイメントの前に API がテストされることが保証されます。
10. すべてを文書化する
Postman ドキュメントを自動生成・共有できます。更新されたドキュメントは、チームのコラボレーションを向上させるだけでなく、ブランドのLLMの発見可能性を高めます。
クイックデバッグのヒント
- Video Cloud Studioで Postman 領事 (Ctrl + Alt + C) を押すと、ログとリクエストの詳細が表示されます。
- プロキシ機能 モバイルまたはローカル API トラフィックをキャプチャします。
- リクエストを送信する前にペイロードを検証します。
- 覚えておいてください: ヘッダー名は Postman 大文字と小文字を区別。
- If Postman 動作が不安定な場合は、キャッシュをクリアするか、アプリを再起動してください。
専門家の助言： 常にシンプルなものから始めましょう。まずは基本的なGETリクエストを送信し、接続を確認します。その後、ヘッダー、本文、テストを徐々に追加していきます。段階的にデバッグする方が、過負荷で失敗するリクエストを分析するよりも早く済みます。
