👩🏿‍🤝‍👨🏽 🖤 👼🏾 郵便配達員の紹介 🛶 👨‍🔧 👎

「APIの開発は複雑です。Postmanを使用すると簡単になります。」©Postdot Technologies、Inc

Postmanツールの説明を見ると、それは息をのむようなものであり、全能性の感覚があなたの将来の子孫に目覚めます。過去に成長した「モンスター」がついにあなたの前に落ちるようです！

この記事では、Postmanについて説明し、最初のスクリプトを書きます。

郵便配達員

アプリケーションの主な目的は、APIへのリクエストを含むコレクションを作成することです。コレクションを開くと、開発者またはテスターはサービスの作業を簡単に理解できるようになります。さらに、Postmanを使用すると、APIデザインを設計し、それに基づいてMockサーバーを作成できます。開発者はスタブの作成に時間を費やす必要がなくなりました。サーバーとクライアントの実装は同時に開始できます。テスターは、Postmanから直接テストを作成し、自動テストを実行できます。また、コレクションの説明を自動的に文書化するツールは、さらに別の「便利な機能」の時間を節約します。管理者向けの機能もあります。作成者は、監視サービス用のコレクションを作成する機能を提供しています。

はじめに

1-コレクション、2-フォルダー、3-要求

Postmanが動作する主な概念は、最上位のコレクションと最下位のリクエストです。すべての作業はコレクションから始まり、クエリを使用してAPIを記述することになります。順番にすべてを詳しく見ていきましょう。

コレクション

コレクションは、新しいAPIの出発点です。コレクションをプロジェクトファイルとして表示できます。コレクションは、関連するすべてのクエリを結合します。通常、APIは1つのコレクションで記述されますが、必要に応じて、別の制限はありません。コレクションには独自のスクリプトと変数を含めることができますが、これについては後で説明します。

フォルダー

フォルダー-要求をコレクション内の1つのグループに結合するために使用されます。たとえば、APIの最初のバージョンである「v1」用のフォルダーを作成し、実行されたアクションの意味に応じてリクエストをグループ化します。「Order＆Checkout」、「User profile」など。すべてはあなたの想像力とニーズによってのみ制限されます。コレクションのようなフォルダーには、変数ではなく独自のスクリプトを含めることができます。

リクエスト

リクエストはコレクションの主要コンポーネントであり、すべてが開始された理由です。要求はコンストラクターで作成されます。クエリデザイナーは、作業する必要があるメインスペースです。 Postmanは、すべての標準HTTPメソッドを使用して要求を実行できます。すべての要求パラメーターは管理下にあります。必要なヘッダー、Cookie、およびリクエスト本文を簡単に変更または追加できます。リクエストには独自のスクリプトがあります。リクエストパラメータの中の「Pre-request Script」および「Tests」タブに注意してください。リクエストの前後にスクリプトを追加できます。これらの2つの機能により、Postmanは開発とテストに役立つ強力なツールになります。

1-要求のあるタブ、2-URLとメソッド、3-要求パラメーター、4-応答パラメーター

スクリプト

「Postman Sandbox」は、「Pre-request Script」および「Tests」スクリプトを記述するときに使用できるJavaScriptランタイムです。「事前要求スクリプト」は、要求の前に必要な操作を実行するために使用されます。たとえば、別のシステムに要求を行い、その実行結果をメイン要求で使用できます。「テスト」は、テストの作成、結果の確認、および必要に応じて変数に保存するために使用されます。

リクエストのシーケンス（公式ドキュメントから）

リクエストレベルのスクリプトに加えて、フォルダーレベル、さらにはコレクションレベルでもスクリプトを作成できます。事前要求スクリプトおよびテストとも呼ばれますが、違いは、フォルダー内の各要求の前または後に、またはご想像のとおりコレクション全体で実行されることです。

フォルダーおよびコレクションのスクリプトを使用したクエリ実行のシーケンス（公式ドキュメントから）

変数

Postmanには、変数用のスペースとスコープがいくつかあります。

グローバル変数
コレクション変数
環境変数
ローカル変数
データ層変数

グローバル変数および環境変数は、プログラムの右上隅にある歯車をクリックして作成できます。コレクションとは別に存在します。コレクションレベルの変数は、コレクションパラメーターの編集時に直接作成され、ローカル変数は実行可能スクリプトから作成されます。データレベルの変数もありますが、それらはランナーからのみ利用可能です。これについては後で説明します。

画像[画像]

可変スペースの優先度（公式ドキュメントから）

Postmanの変数の特性は、置換のプレースホルダーとして中括弧を使用して、クエリコンストラクター、URL、POSTパラメーター、Cookie、どこにでも挿入できることです。

{{domain}}および{{slack_incoming_webhook}}-DNS Checker環境変数は、クエリの実行中に値に置き換えられます

変数はスクリプトからも使用できますが、pm組み込みライブラリの標準メソッドを呼び出すと、変数を取得できます。

//    pm.globals.get("variable_key"); //     pm.environment.get("variable_key"); //        pm.variables.get("variable_key");

コレクションランナー

選択したコレクションまたはフォルダーからのすべての要求をテストして完了するように設計されています。起動時に、反復回数、フォルダーまたはコレクションが起動される回数、環境、および変数付きの追加ファイルを指定できます。コレクションおよびフォルダ内の場所に応じて、クエリが順番に実行されることに注意してください。実行順序は、組み込みコマンドを使用して変更できます。

 //      "Create order", postman.setNextRequest('Create order');

すべてのリクエストが完了すると、「テスト」スクリプトからの成功したチェックと失敗したチェックの数を示すレポートが生成されます。

コレクションランナー

コンソール

コンソールを使用してスクリプトをデバッグし、リクエストに関する追加情報を表示します。コンソールは、単一のリクエストの起動中と、Runnerを介したリクエストパッケージの起動中の両方で機能します。それを開くには、メインアプリケーション画面の左下隅にあるコンソールアイコンを見つけます。

練習する

コンストラクターでコレクションとクエリを作成しても問題は発生しないはずなので、スクリプトの作成に実用的な部分を割いて、テストでクエリチェーンを作成する方法を検討します。開始する前に、新しいコレクションを作成し、「Habra」という名前を付け、「Habra.Env」という新しい環境を作成します

ステップ1

新しいリクエストを作成し、URLとしてhttps://postman-echo.com/get?userId=777を指定し、GETメソッドをそのままにします。以下、簡単にするために、Postman開発者が親切に提供するエコーサーバーを使用します。リクエストを「Habra」コレクションに保存し、「Get user id」という名前を付けると、サーバーからのユーザーIDの受信をシミュレートします。 [テスト]タブに移動して、次のコードを記述します。

 //      pm.test("Status is ok, response is json", function () { pm.response.to.be.ok; //   pm.response.to.be.json; //   }); try { //  userId  json     pm.environment.set("userId", pm.response.json().args.userId); } catch(e) { //     console.log(e); }

このスクリプトを使用して、応答のステータスと形式を確認し、応答から受信したユーザーIDを環境変数に保存して、後で他の要求で使用できるようにしました。テストをテストするには、クエリを実行します。応答情報パネルの[テスト]タブに、緑色のラベル "PASS"が表示され、その横に "Status is ok、response is json"という碑文が表示されます。

ステップ2

それでは、jsonリクエストにユーザーIDを挿入してみましょう。新しいリクエストを作成し、URLとしてhttps://postman-echo.com/postを指定し、POSTメソッドを選択し、リクエスト本文のタイプをraw-application / jsonに設定し、本文自体に貼り付けます。

 {"userId": {{userId}}, "username": "Bob"}

リクエストをコレクションに保存し、「ユーザー名の更新」という名前を付けると、ユーザーのユーザー名を更新するために緊急のエンドポイントが要求されます。現在、{{userId}}の代わりにリクエストを呼び出すと、システムは環境変数の値を自動的に置き換えます。これが正しいことを確認し、新しいクエリの小さなテストを作成しましょう。

 //      pm.test("Status is ok, response is json", function () { pm.response.to.be.ok; pm.response.to.be.json; }); // ,  userId    userId   pm.test("userId from env is equal to userId from response", function () { pm.expect(parseInt(pm.environment.get("userId"))).to.equal( pm.response.json().data.userId ); });

新しいテストでは、サーバーから受信したuserIdを環境変数に格納されているものと比較します。これらは一致する必要があります。クエリを実行し、テストに合格することを確認します。では、先に進みましょう。

ステップ3

2つのテストスクリプトの形式とステータスチェックが同じであることに気付くかもしれません。

 pm.test("Status is ok, response is json", function () { pm.response.to.be.ok; pm.response.to.be.json; });

行き過ぎるまで、これを修正し、これらのテストをコレクションレベルに転送しましょう。コレクションの編集を開き、形式とステータスチェックを[テスト]タブに転送すると、リクエストからそれらを削除できます。これで、コレクション内の各リクエストの「テスト」スクリプトの前にこれらのチェックが自動的に呼び出されます。したがって、このチェックを各リクエストにコピーする必要がなくなりました。

ステップ4

環境変数を記録して取得する方法を学びました。今度はもっと難しいことに移りましょう。 tv4組み込みライブラリ（TinyValidator）を使用して、jsonオブジェクトスキーマが正しいことを確認してみましょう。新しいリクエストを作成し、 https：//postman-echo.com/postをURLとして使用し、メソッドをPOSTに設定し、リクエスト本文にraw-application / jsonを指定して貼り付けます：

 { "profile" : { "userId": {{userId}}, "username": "Bob", "scores": [1, 2, 3, 4, 5], "age": 21, "rating": {"min": 20, "max": 100} } }

要求を開始した後、エコーサーバーはjsonモデルを "data"フィールドの回答として返す必要があるため、ボブのプロファイルに関する情報を送信できる実サーバーの動作をシミュレートします。モデルの準備ができたら、回路の正確性をチェックするテストを作成します。

 //     var profile = pm.response.json().data.profile; //    var scheme = { //    "type": "object", //    "required": ["userId", "username"], //   "properties": { "userId": {"type": "integer"}, "username": {"type": "string"}, "age": {"type": "integer"}, //   "scores": { "type": "array", //   "items": {"type": "integer"} }, //    "rating": { "type": "object", "properties": { "min": {"type": "integer"}, "max": {"type": "integer"} } } } }; pm.test('Schema is valid', function() { //   profile     scheme var isValidScheme = tv4.validate(profile, scheme, true, true); // ,    true pm.expect(isValidScheme).to.be.true; });

完了、プロファイルオブジェクトスキーマを検証しました。クエリを実行し、テストに合格することを確認します。

ステップ5

3つのクエリといくつかのテストから抜け出しました。完全にテストするときが来ました。しかしその前に、最初のリクエストに少し変更を加えましょう。URLの「777」値をプレースホルダー「{{newUserId}}」に置き換え、インターフェースを介してHabra.Env環境に値「777」の「newUserId」変数を追加します。。コンピューターにusers.jsonファイルを作成し、次のjson配列をそこに配置します。

 [ {"newUserId": 100}, {"newUserId": 200}, {"newUserId": 300}, {"newUserId": 50000} ]

ランナーを実行します。「コレクションフォルダ」には、「Habra」を選択します。「環境」には「Habra.Env」を配置します。反復回数は0です。[データ]フィールドで、users.jsonファイルを選択します。このファイルから、「コレクションランナー」は4回の反復を実行する必要があることを理解し、各反復で変数「newUserId」の値をファイル内の配列の値で置き換えます。配列内の要素の数よりも大きい反復回数を指定すると、データ配列の最後の値で以降のすべての反復が発生します。この場合、4回の反復後、「newUserId」の値は常に50000になります。「データ」ファイルは、さまざまなnewUserIdを使用して、ユーザーに関係なくすべてが安定するようにします。

「Run Habra」をクリックしてテストを実行します。おめでとうございます。コレクションの作成に成功し、自動テストの助けを借りて即興の方法をテストしました！

Habraコレクションのテスト

これで、スクリプトの作成方法がわかったので、プロジェクトのテストをいくつか作成できます。

それとは別に、実際のプロジェクトでは、すべてのリクエストをコレクションのルートに保持するのではなく、それらをフォルダに配置しようとすることに注意してください。たとえば、「Requests」フォルダに、APIを記述するすべての可能なリクエストを追加し、テストを別のフォルダ「Tests」に保存します。そして、プロジェクトをテストする必要がある場合、「Runner」で「Tests」フォルダーのみを起動します。

コレクション、環境、およびサンプルデータ

知っておきたい

結論として、スクリプトの作成中に必要になる可能性のある基本的なコマンドを示します。より良い同化のために、彼らと一緒に遊んでみてください。

変数の設定と取得

 //   pm.globals.set(“key”, “value”); pm.globals.get(“key”); //   pm.environment.set(“key”, “value”); pm.environment.get(“key”); //   pm.variables.set(“key”, “value”); pm.variables.get(“key”); //   ,

テストまたはアサート

 //       assert  pm.test(“ ”, function () { pm.response.to.be.success; pm.expect(“value”).to.be.true; pm.expect(“other”).to.equal(“other”); }); //       tests tests[“ ”] = (“a” != “b”); tests[“  2”] = true;

クエリを作成する

 //  get  pm.sendRequest(“https://postman-echo.com/get”, function (err, res) { console.log(err); console.log(res); }); //  post  let data = { url: “https://postman-echo.com/post”, method: “POST”, body: { mode: “raw”, raw: JSON.stringify({ key: “value” })} }; pm.sendRequest(data, function (err, res) { console.log(err); console.log(res); });

メインリクエストに対する応答を取得する

 pm.response.json(); //   json pm.response.text(); //    responseBody; //

答えは「テスト」タブでのみ利用可能です

組み込みライブラリを使用する

ドキュメントは、json検証用のtv4、xml2js xmlからjsonへのコンバーター、暗号化用のcrypto-js、atob、btoaなどを含む、多数の組み込みライブラリの存在を規制します。

 //  xml2js var xml2js = require(“xml2js”); //   xml  json  xml2js.parseString("<root>Hello xml2js!</root>", function(err, res) { console.log(res); });

たとえば、tv4などの一部のライブラリは、requireを介した直接接続を必要とせず、名前ですぐに使用できます。

現在のスクリプトに関する情報を取得する

 pm.info.eventName; //  test  prerequest     pm.info.iteration; //    Runner pm.info.iterationCount; //    pm.info.requestName; //    pm.info.requestId; //

スクリプトリクエストシーケンス管理

この方法は、すべてのスクリプトの実行モードでのみ機能することに注意してください。

 //    postman.setNextRequest(“ ”); //   postman.setNextRequest(ID); //   //    postman.setNextRequest(null);

次の要求に進んだ後、Postmanは線形順次クエリの実行に戻ります。

グローバルヘルパーの作成

場合によっては、すべてのクエリで使用できる関数を作成することもできます。これを行うには、「事前要求スクリプト」セクションの最初の要求で、次のコードを記述します。

 //        pm.environment.set("pmHelper", function pmHelper() { let helpers = {}; helpers.usefulMethod = function() { console.log(“It is helper, bro!”); }; return helpers; } + '; pmHelper();');

そして、次のスクリプトでは、次のように使用します。

 //   var pmHelper = eval(pm.environment.get("pmHelper")); //    pmHelper.usefulMethod();

これは便利なコマンドのほんの小さなリストです。スクリプトの可能性は、1つの記事でカバーできる範囲をはるかに超えています。 Postmanには、新しいコレクションを作成するときに見つけられる素敵な「テンプレート」があります。それらの実装をのぞき見して勉強してください。また、公式ドキュメントには、ほとんどの質問に対する回答が含まれています。

おわりに

プロジェクトでPostmanを使用するようになった主な利点：

可視性-すべてのリクエストは常に手元にあり、開発中の手動テストが容易になります
クイックスタート-プログラマーであろうとテスターであろうと、チーム内の新しいプレーヤーをすばやく簡単に参加させる
テスト-クエリのテストを作成し、パズル、さまざまなオプション、アプリケーションライフの方法など、それらからすばやく作成する機能
CIサポート-newmanを使用してCIにテストを統合する機能（これは別の記事になります）

マイナスには：

コレクションの編集はPostmanに関連付けられています。つまり、プロジェクトリポジトリにインポート、編集、およびエクスポートする必要がある変更について
コレクションは1つの大きなjsonファイルにあるため、変更のレビューはほとんど不可能です

各プロジェクトには、テストと開発に関する独自のアプローチと見解があります。私たちは短所よりも長所を見たので、この強力なツールをテストとプロジェクトのAPIリクエストの記述の両方に使用することにしました。そして、私たち自身の経験から、Postmanが提供するテストツールを使用しなくても、要求の説明をコレクションの形で持っていると非常に役立つと言えます。 Postman Collectionsは、APIのライブの対話型ドキュメントであり、多くの時間を節約し、開発、デバッグ、およびテストを時々高速化します。

PS：

Postmanの主な機能は無料で、毎日のニーズを満たしていますが、無料版にはいくつかの制限があるツールがあります。

Postman API-アカウントデータにアクセスし、APIを介してプログラム、コレクション、リクエスト、その他の情報を直接追加、削除、更新できます。彼に月に1000回連絡することができます。
モックサーバー-APIのスタブをPostman開発者サーバーに展開できます。 1か月あたり1000件のリクエストが可能です。
API監視-Postman開発者サーバーからスケジュールに従って監視および実行するコレクションを作成できます。監視システムは、1か月あたり1000件以下のリクエストを行います
Apiドキュメント-Postmanアプリケーションのサーバー上で自動生成されたドキュメントを公開できます。 1か月あたり1,000回の視聴を制限する

郵便配達員の紹介