POSTMANチュートリアル：POSTMANを使用したAPIテスト

postman tutorial api testing using postman

このステップバイステップのチュートリアルでは、POSTMANの基本、そのコンポーネント、およびサンプルの要求と応答を含む、POSTMANを使用したAPIテストについて説明します。

最もよく聞かれる質問を見てみました ASP.NetおよびWebAPIインタビューの質問 前のチュートリアルで。このチュートリアルを実行することで、特定のURLに対してPOSTMANを介してAPIテストにアプローチする方法を学習します。

Postmanは、非常にシンプルで直感的なAPIテストツールまたはアプリケーションです。 POSTMANのすべてのコンポーネントは、独自の重要性を持っているため、非常に重要です。

=> ここで完全なAPIテストシリーズをお読みください 。

どこで無料のアニメをオンラインで見ることができますか

このシリーズのすべての郵便配達員チュートリアルのリスト

チュートリアル＃1： 郵便配達員の紹介（このチュートリアル）
チュートリアル＃2： 差分API形式をテストするためにPostmanを使用する方法
チュートリアル＃3： Postman：可変スコープと環境ファイル
チュートリアル＃4： Postmanコレクション：コードサンプルのインポート、エクスポート、生成
チュートリアル＃5： アサーションを使用した応答検証の自動化
チュートリアル＃6： Postman：PreRequestおよびPostRequestスクリプト
チュートリアル＃7： Postman Advanced Scripting
チュートリアル＃8： Postman –Newmanとのコマンドライン統合
チュートリアル＃9： Postman –Newmanを使用したレポートテンプレート
チュートリアル＃10： Postman –APIドキュメントの作成
チュートリアル＃11： 郵便配達員のインタビューの質問

Postmanシリーズのチュートリアルの概要

学習内容：

• POSTMANの紹介
• POSTMANのインストール
  • Postman Native App
  • 代替のQuickPostmanインストールガイド
  • POSTMANのビルディングブロック
    • ＃1）リクエスト
    • ＃2）コレクション
    • ＃3）環境
  • リクエストをコレクションに保存する
• サンプルのリクエストとレスポンス
• 更新：追加情報
  • APIとは何ですか？
  • POSTMANクライアント
    • POSTMANクライアントをダウンロードする方法は？
  • POSTMANクライアントを使用してRESTAPIを呼び出す
    • ＃1）電話をかける
    • ＃2）POSTコール
    • ＃3）PUT Call
    • ＃4）通話を削除する
  • APIテストの課題
• 結論
  • 推奨読書

POSTMANの紹介

POSTMANは、APIの開発、テスト、共有、および文書化に使用されるAPIクライアントです。これは、エンドポイントURLを入力し、サーバーに要求を送信し、サーバーから応答を受信するバックエンドテストに使用されます。 SwaggerなどのAPIテンプレートでも同じことができます。 SwaggerとPOSTMANの両方で、サービスから応答をフェッチするためにフレームワークを構築する必要はありません（Parasoftとは異なります）。

これが、POSTMANが開発者や自動化エンジニアによって頻繁に使用され、リージョンにデプロイされているAPIのビルドバージョンとともにサービスが稼働していることを確認する主な理由です。

これは基本的に、API仕様に従ってリクエストをすばやく作成し、ステータスコード、ヘッダー、実際の応答本文などのさまざまな応答パラメーターを分析することで、APIエンドポイントに到達するのに役立ちます。

これがビデオチュートリアルです：

Postmanは、次のような多くの高度な機能を提供します。

• API開発。
• まだ開発中のAPIのモックエンドポイントを設定します。
• APIドキュメント。
• APIエンドポイントの実行から受信した応答のアサーション。
• Jenkins、TeamCityなどのCI-CDツールとの統合。
• APIテストの実行などの自動化。

これで、ツールの正式な紹介が完了しました。インストールの部分に進みましょう。

POSTMANのインストール

Postmanには2つのオプションがあります。

1. Chromeアプリとして（これはすでに非推奨であり、Postman開発者からのサポートはありません）
2. Windows、Mac OS、Linuxなどのさまざまなプラットフォーム用のネイティブアプリ。

Chromeアプリは非推奨になり、Chromeブラウザー（場合によっては実際のブラウザーバージョン）と緊密に連携しているため、主にネイティブアプリケーションを使用することに焦点を当てます。これにより、制御が強化され、外部依存関係が少なくなります。

Postman Native App

Postman Nativeアプリは、次の目的で利用できるスタンドアロンアプリです。 ダウンロード Windows、Mac OS、LinuxなどのさまざまなOSプラットフォームで。これは、ユーザーのプラットフォームに応じて、他のアプリケーションと同じようにダウンロードできます。

インストールプロセスも非常に簡単です。ダウンロードしたインストーラー（WindowsおよびMacの場合）をダブルクリックして、指示に従うだけです。

インストールが成功したら、Postmanアプリケーションを開いて開始します。

利用可能なオープンソースAPIの簡単なリクエストを作成する方法と、Postmanアプリケーションを使用してリクエストが実行されたときに受信されるリクエストとレスポンスのさまざまなコンポーネントを確認します。

既存の電子メールアカウントを使用してPostmanアプリケーションにサインイン/サインアップすることを強くお勧めします。サインインしたアカウントは、セッション中に保存されたすべてのPostmanコレクションとリクエストを保持し、同じユーザーが次回ログインしたときにリクエストを引き続き使用できるようにします。

を参照してください 注意 公開されている偽のAPIエンドポイントの詳細を取得するセクション。

これに対するサンプルのGETリクエストを説明します URL これは、JSONペイロードとして応答として100件の投稿を返します。

始めて、従う必要のある手順を見てみましょう。

＃1） Postmanアプリケーションを開きます（既存または新しいアカウントでまだログインしていない場合は、最初に適切な資格情報を使用してログインします）。

以下に、PostmanUIの初期画面の画像を示します。

＃二） 新しいリクエストを作成し、テストまたは図に使用するエンドポイントに従って詳細を入力します。 RESTAPIエンドポイントのgetリクエストをテストしてみましょうhttp://dummy.restapiexample.com/api/v1/employees

＃3） リクエストのプロパティが入力されたら、SENDを押して、エンドポイントをホストしているサーバーへのリクエストを実行します。

＃4） サーバーが応答すると、応答に関するさまざまなデータを確認できます。

それぞれを詳しく見ていきましょう。

デフォルトでは、応答が完了すると、応答本文タブが選択されて表示されます。応答ステータスコード、要求の完了にかかる時間、ペイロードのサイズなど、応答の他のパラメーターは、要求ヘッダーのすぐ下に表示されます（下の図を参照）。

応答サイズや応答時間などの応答パラメーターに関する詳細を取得するには、これらの各値にカーソルを合わせるだけで、Postmanにより、これらの各プロパティの詳細が詳細に表示されます。

例えば、 リクエスト時間の場合–接続時間、ソケット時間、DNSルックアップ、ハンドシェイクなどの個々のコンポーネントにさらに分析します。

同様に、応答サイズの場合、ヘッダーが構成されているサイズの内訳と、実際の応答サイズが表示されます。

それでは、他の応答タブ、つまりCookieとヘッダーを見てみましょう。 Webの世界では、Cookieは、サーバーから返されたCookieに関するすべての情報を取得するために、クライアント側のエクスペリエンスとセッション関連の情報を促進するという点で非常に重要です。 (Cookie)タブに切り替えて、これを確認できます。

同様に、応答ヘッダーには、処理された要求に関する多くの有益な情報が含まれています。応答セクションの(ヘッダー)タブに移動して、応答ヘッダーを確認してください。

ここで注意すべき重要な点は、サーバーに対して行うすべてのリクエストは、後で参照できるようにPostmanの履歴に保存されることです（(履歴)タブはアプリの左側のパネルにあります）。

これは、同じリクエストに対する応答を取得する必要があるたびにリクエストが作成されるのを防ぐのに役立ち、日常的な定型的なタスクを回避するのにも役立ちます。必要に応じて、将来の時点で過去のリクエスト（およびレスポンスも）を参照できます。

注意： サンプルのリクエストとレスポンスを説明するために、公開されている偽のAPIサーバーを使用します。これにより、すべてのタイプのHTTPリクエストを実行でき、有効なHTTPレスポンスが返されます。

いくつか例を挙げると、以下の偽のAPIエンドポイントサイトを参照として使用します。

1. RestAPIの例
2. JSONプレースホルダーのタイプコード

代替のQuickPostmanインストールガイド

POSTMANはオープンツールであり、インターネットを閲覧するすべての人が利用できます。以下の手順に従って、POSTMANツールをローカルマシンにインストールできます。

ステップ1： 開いた グーグル POSTMANツールを検索します。以下の検索結果が表示されます。次に、(Postmanアプリのダウンロード)をクリックすると、getpostmanWebサイトにリダイレクトされます。

それ以外の場合は、これに直接移動できます URL POSTMANツールを入手します。

ステップ2： オペレーティングシステムに基づいてPOSTMANバージョンを選択します。この例では、WindowsOS用のPOSTMANを使用します。さらに、Window-64ビットを使用しているため、64ビット用のPOSTMANをダウンロードしてインストールします。

ステップ3： (ダウンロード)ボタンをクリックすると、postman.exeファイルがローカルにダウンロードされます。そのファイルをクリックします。これは、ブラウザにPOSTMANアドオンをインストールできる他のアプリケーションと同じように、ワンクリックでインストールできます。

ステップ4： アプリケーションをインストールしたら、アプリケーションをクリックします（デスクトップに配置する必要があります）。下の画像でわかるように、6つの異なるエンティティがあり、基本的に3つのビルディングブロック、つまり、次のセクションで説明するリクエスト、コレクション、環境が必要になります。

それでおしまい！！ POSTMANアプリケーションのインストールと起動に成功しました。

POSTMANのビルディングブロック

POSTMANにはさまざまな構成要素がありますが、ここでは、すべてのPOSTMAN操作に不可欠な3つの主要な構成要素について説明します。

これらの3つの主要な構成要素は次のとおりです。

＃1）リクエスト

リクエストは、完全なURL（すべてのパラメーターまたはキーを含む）、HTTPヘッダー、本文、またはペイロードの組み合わせに他なりません。これらの属性はすべて、リクエストを形成します。 POSTMANを使用すると、リクエストを保存できます。これは、同じリクエストを何度でも使用できるアプリの優れた機能です。

クリック 新規->リクエスト

＃2）コレクション

一括リクエストを保存する場所が必要です。これは、コレクションが登場するシナリオです。コレクションは、すべてのリクエストを保存できるリポジトリであると言えます。通常、同じAPIにヒットするリクエストは、同じコレクションに保持されます。

クリック 新規->コレクション。

＃3）環境

環境は、APIに対するすべての操作が行われる領域です。 TUP、QA、Dev、UAT、またはPRODの場合があります。各プロジェクトにはすでにリージョンが構成されており、URL、トークンのIDとパスワード、コンテキストキー、APIキー、ドキュメントキーなどのグローバル変数を宣言するだけです。

クリック 新規->環境。

リクエストをコレクションに保存する

次に、サンプルリクエストをコレクションに保存してみます。同じリクエストを使用してAPIをヒットします。

ステップ1： 右上隅に「+新規」ボタンが表示されます。このボタンをクリックすると、アプリケーションを初めて起動したときに表示されたビルディングブロックのリストが表示されます。

ステップ2： (リクエスト)をクリックします。

ステップ3： 必須フィールドであるリクエスト名を入力します。次に、「+コレクションの作成」をクリックします。

ステップ4： 「+コレクションの作成」をクリックすると、名前の入力を求められます（サンプルコレクションなど）。コレクションの名前を入力し、Enterキーを押します。

ステップ5： クリックしてください 「サンプルコレクションに保存」 ボタン。

サンプルのリクエストとレスポンス

この特定のセクションでは、POSTMANでAPIをテストする方法について深い洞察を提供します。

下の画像でわかるように、すでに作成したリクエストがあります（Test for SoftwareTestingHelp）。さらに、POSTMANでサポートされている動詞またはメソッドを含むドロップダウン（URLのすぐ横）が表示されます。

これらはHTTP動詞と呼ばれます。 PUTメソッドを使用して何かを更新しようとし、次にGETメソッドを使用して同じものを取得します。読者は、APIテストで使用されるこれらのHTTP動詞の機能を知っていると思います。

これで、URLとリクエストメソッドができました。必要なのは、ヘッダーとペイロードまたは本体だけです。場合によっては、（APIのニーズに基づいて）トークンを生成する必要があります。

HTTPヘッダー、つまりContent-TypeとAcceptを宣言します。 Acceptは、応答を取得する形式を決定するため、必ずしも必須ではありません。デフォルトでは、応答は常にJSONです。

キーと値のテキスト領域に入力するとPOSTMANが提案を提供するため、これらのヘッダーの値をマグカップする必要はありません。

次に、次の必須セクションであるBodyに進みます。ここでは、JSONの形式でペイロードを提供します。私たちは独自のJSONを作成する方法を知っているので、独自のJSONを作成しようとします。

サンプルリクエスト

URL： http://www.mocky.io/v2/5cd6c3f23000004b006061c5

ヘッダー

コンテンツタイプ：アプリケーション/ JSON
Accept = application / JSON

体

今それを打つ

リクエストが完了したら、(送信)ボタンをクリックして、応答コードを確認します。 200 OKコードは、正常な操作を表します。下の画像では、URLに正常にアクセスしたことがわかります。

次のステップ

次に、GETという別の操作を実行します。作成したものと同じレコードをフェッチしようとします。

GET操作に本体やペイロードは必要ありません。 PUTメソッドを使用したサンプルリクエストはすでにあるので、必要なのはメソッドをGETに変更することだけです。

GETに変更したら、サービスを再開します。下の画像でわかるように、通過したものを正確に取得しました。これがPOSTMANの動作方法です。

更新：追加情報

APIとは何ですか？

API（アプリケーションプログラミングインターフェイス）はjarファイルであり、特定のアクションを実行するためのいくつかのメソッドとインターフェイスが含まれています。

Windows 764ビットに最適なファイアウォール

以下の例とスクリーンショットを参照してください。

1. 2つの変数を追加し、2つの変数の合計を返すsumメソッドを作成します。
2. 次に、加算、減算、乗算、除算など、他のいくつかのメソッドを含む電卓クラスを作成します。いくつかのヘルパークラスもあるかもしれません。次に、すべてのクラスとインターフェイスを組み合わせて、Calculator.jarというjarファイルを作成して公開します。 Calculator APIを使用して、内部に存在するメソッドにアクセスします。
3. 一部のAPIは編集可能なオープンソース（Selenium）であり、一部は編集できないライセンスされたAPI（UFT）です。

推奨読書=> トップAPI管理ツール

これらのメソッドはどの程度正確に呼び出されますか？

開発者は、電卓APIを呼び出すためのインターフェース、プラットフォームを公開し、電卓クラスのオブジェクトを作成して、sumメソッドまたは任意のメソッドを呼び出します。

このcalculator.jarファイルが何らかの会社によって作成され、UIインターフェイスを介してこのユーティリティを使用するとします。次に、UIを使用してこの計算機アプリケーションをテストし、QTP / Seleniumを使用して自動化します。これはフロントエンドテストと呼ばれます。

一部のアプリケーションにはUIがないため、これらのメソッドにアクセスするために、クラスのオブジェクトを作成し、テストする引数を渡します。これは次のように呼び出されます。 バックエンドテスト 。リクエストの送信とレスポンスの受信は、 JSON / XMLファイル。

次の図を参照してください。

POSTMANクライアント

• POSTMANは、バックエンドAPIテストの実行に使用されるRESTクライアントです。
• POSTMANでは、API呼び出しを渡し、API応答、ステータスコード、およびペイロードを確認します。
• Swaggerは、APIドキュメントを作成するもう1つのHTTPクライアントツールであり、Swaggerを使用して、APIをヒットして応答を取得することもできます。
• リンクhttps://swagger.io/を参照してください
• SwaggerまたはPOSTMANのいずれかを使用してAPIをテストできます。これは、使用するクライアントとして企業によって異なります。
• POSTMANでは、主にGET、POST、PUT、およびDELETE呼び出しを使用します。

POSTMANクライアントをダウンロードする方法は？

Google Chromeを開き、Chromeアプリストアで入手できるPOSTMANアプリをダウンロードします。

POSTMANクライアントを使用してRESTAPIを呼び出す

POSTMANには多くのメソッドがありますが、使用するのはGET、PUT、POST、およびDELETEのみです。

• 役職 –この呼び出しにより、新しいエンティティが作成されます。
• 取得する –この呼び出しは要求を送信し、応答を受信します。
• プット –この呼び出しにより、新しいエンティティが作成され、既存のエンティティが更新されます。
• 削除 –この呼び出しにより、既存のエンティティが削除されます。

APIには、銀行プラットフォームなどのUIを使用するか、POSTMANなどのRESTAPIクライアントを使用するバックエンドシステムのようにUIを使用できない場合にアクセスできます。

RESTおよびSOAPクライアントであるSOAPUI、のような高度なRESTクライアントなどの他のクライアントも利用できます。 JMeter ブラウザから直接APIを呼び出すことができます。 POSTMANは、POSTおよびGET操作を実行するための最適なツールです。

また読む=> 詳細なSoapUIチュートリアルのリスト

POSTMANクライアントでリクエストを送信してレスポンスを取得します。

テストの目的で、提供されているAPIを使用します ここに 。

ダミーサイトが提供するAPIを使用して、POSTMANクライアントで各CRUD呼び出しを確認します。

APIテストでは、主に以下の点を検証します。

• 応答ステータスコード、参照 wikiページ 詳細については。
• 応答メッセージとJSON応答本文。
• APIテストでは、まず、開発者にエンドポイントURLを提供するように依頼します。このエンドポイントURLhttps：//reqres.in/を参照してください。

＃1）電話をかける

要求を送信し、応答を受信します。

REST APIをテストする手順：

• パス https://reqres.in//api/users?page=2 (？は、2ページにユーザーのすべての情報を出力するなどの結果をフィルターで除外するクエリパラメーターです。クエリパラメーターは、POSTMANクライアントでURIとして定義する方法として開発者に依存します。
• クエリパラメータは（？）で定義され、パスパラメータは（/）で定義されます。
• GETメソッドを選択します。

• User-Agent：「ソフトウェア」のようなヘッダー（必要な場合）を提供します。

• (送信)ボタンをクリックします。
• APIが正常に機能している場合、応答として次のようになります。
  • ステータス200– OK、これは応答が正常に受信されたことを意味します。
  • 応答JSONペイロード。
  • 文字列メッセージ

• 別の 例 特定のユーザーに関する情報、つまりユーザーID = 3を検索したGETメソッドの例。 URIを入力= https://reqres.in/api/users/3

• 検索に対してデータが利用できない場合、空白のJSONと404ステータスメッセージが表示されます。

＃2）POSTコール

新しいユーザーまたはエンティティを作成します。

実行する手順：

• ドロップダウンからPOSTを選択し、このサービスURL「https://reqres.in/api/users/100」を使用します
  
• 本文に移動–> RAWを選択-> JSONを渡すため。
• ドロップダウンからJSONを選択し、ペイロードスクリプトを貼り付けます。
• このペイロードを渡す{“ name”：” Morpheus”、” job”：” Leader”}

• JSONは中括弧で始まり、データをキーと値の形式で格納します。
• ヘッダーコンテンツタイプ= application / jsonを渡します。
• SENDボタンを押します。

• リクエストが成功すると、次の応答が返されます。
  • ステータス201–作成済み、応答は正常に受信されました。
  • 応答ペイロード
  • ヘッダ

＃3）PUT Call

新しいエンティティを更新または作成します。

PUTコールを作成する手順：

• このサービスURL「https://reqres.in/api/users/206」とペイロード{「name」：「Morpheus」、「job」：「Manager」を使用します
• POSTMANクライアントに移動し、PUTメソッド->本文に移動-> RAWを選択> JSONを渡し、ドロップダウンからJSONを選択して、ペイロードスクリプトを貼り付けます。
• JSONは中括弧で始まり、データをKey-Value形式で格納します。
• SENDボタンを押すと、リクエストが成功すると、以下の応答が返されます。
  • ステータス200– OK、応答は正常に受信されました。
  • 応答ペイロード
  • ヘッダ
  • ジョブが「マネージャー」に更新されました

＃4）通話を削除する

• ユーザーを削除し、このサービスURL「/ api / users / 423」とこのペイロード{「name」：「Naveen」、「job」：「QA」}を使用します。
• POSTMANに移動し、DELETEメソッドを選択します。ペイロードは不要です。
• システムで使用可能な場合、ユーザーID = 423を削除します。
  • ステータス204–コンテンツなし、応答は正常に受信されました。
  • ペイロードを受信せず、ユーザーIDを削除しました。
  • ヘッダ

APIテストの課題

• テストケースは、テストカバレッジをカバーするように設計する必要があります。
• APIが運ぶパラメーターが少ない場合、テストケースの設計は簡単ですが、パラメーターの数が多い場合は複雑さが増します。
• ビジネス要件の変更に応じて、テストカバレッジを定期的に更新します。新しいパラメータが追加された場合は、テストハーネススイートを増やします
• API呼び出しの適切な順序付け。
• 境界条件とパフォーマンスを調べます。

結論

このチュートリアルでは、PostmanAPIテストツールを使い始めるための重要なポイントについて説明しました。 Postmanツールをスタンドアロンアプリケーションとしてインストールする方法を学び、簡単なリクエストを作成して生成されたレスポンスを確認する方法について説明しました。

応答情報のさまざまな部分に移動する方法と、(履歴)タブからリクエストを確認して取得する方法を確認しました。

これで、APIで正常な操作を実行できると確信しています。 APIでの操作が成功したからといって、本文全体、ヘッダー、その他の必要なブロックをコピーして貼り付け、テストの実行を成功させることにはなりません。

独自のJSONの作成、ドキュメントキーまたはパラメーターを使用したJSONの特定のフィールドへの移動、JSONの配列の理解などにどれだけ慣れているかが重要です。

POSTMANクライアントツールは、バックエンドテストを実行するため、および主にGET、PUT、POST、DELETE呼び出しを実行するために使用されます。

このチュートリアルから、POSTMANクライアントからの呼び出しをヒットする方法と、サーバーから返される応答を検証する方法を学び、APIテストの課題についても説明しました。

APIテストは、ハッカーがAPIを悪用して経済的損失を引き起こすため、APIの抜け穴を見つけるために非常に重要です。 APIテストは単純に見えますが、非常に注意して、考えられるすべての組み合わせでテストしてみてください。

今後のチュートリアルでは、DiffAPI形式でPostmanツールを使用する方法を学習します。

前のチュートリアル | 次のチュートリアル

推奨読書

• Parasoft SOAtestチュートリアル：スクリプトレスAPIテストツール
• APIテストチュートリアル：初心者向けの完全ガイド
• 最高のソフトウェアテストツール2021 (QAテスト自動化ツール)
• 破壊検査と非破壊検査のチュートリアル
• 機能テストと非機能テスト
• WAVEアクセシビリティテストツールチュートリアル
• アクセシビリティテストチュートリアル（完全なステップバイステップガイド）
• SOAテストチュートリアル：SOAアーキテクチャモデルのテスト方法