Postman Collection と ブルーバッジ
今日はPostman Collectionについてまとめていきます。
Postman Collectionとは？
Postman の Workspaces が提供しているAPIテスト用コマンドを纏めて管理できる機能です。個別のAPIコールを目的ごとにグルーピングし、詳細情報やAPI用ドキュメントを記載し任意のPostmanユーザーや時にはPublicに公開することが可能です。
まずさっそくやってみる
Postmanにはアカウント開設時にデフォルトでいくつかのCollectionが設定されていますが、話をシンプルにするために一度全て削除します。
コレクションを作成ボタンを押します。
概要タブで概要を記載します。
リクエストの追加をクリックします。
この記事で試したようにrequestcatcherを用いてPOSTとGET二つのAPIコールを作成します。この記事ではAPIコール成功の可否は問題ではありませんので、適当でも大丈夫です。
管理目的でフォルダーを追加して以下のように構造化させることも可能です。
コレクションの実行
コレクションはタダのAPIコールの管理ではなく、管理単位でまとめてAPIコールを実行させることが可能です。したがってDeploy時のモンキーテストなどを纏めておくことで、テストの自動化などに使えます。
フォルダーの実行を選択するとどのAPIコールを実行させるかを選択可能な画面が出てきます。
Shcedule runsを選択することで手動ではなく定期的な実行も可能になります。
その際実行結果をEmailで通知してくれる機能が備わっています。
では手動にして10回実行してみます。
以下のように実行の個別結果および統計情報が表示されます。
パフォーマンスも実行してくれるのであればこれはなかなか便利ではないでしょうか。
では次にスケジュール実行を行ってみます。無料版では１時間単位か日/週単位でしか設定できないため、以下の通り１時間で設定します。
Flows との違い
で触れたFlowsと似た機能も存在していますが、Flowsとは異なり複数のAPIコールを纏めて実行することやその管理は可能ですが、ワークフローなどの機能はありません。またFlowsはFQLにより変数の処理などが可能となっているため、複雑な制御はFlowが向いています。
そして個別のAPIコールはFlowsと管理が共通化しています。逆に言えば、FlowsでAPIコールを作成する場合、それはCollectionで管理されている必要がります。
Flows側で作成したAPIコールはCollectionに自動で加わります。
共有とブルーバッジ
自分が作成したCollectionはチーム間やパブリックに公開させることが可能です。上部の検索バーからcollectionを選び適当な名前で検索してみて下さい。
これらは殆どの場合公式ではなく有志が作成したものです。このため品質などが良くわかりません。ここで役に立つのがブルーバッジです。
例えばfreeeと検索してみて下さい。
結果にブルーバッジがついています。これが公式を表すマークです。
ではクリックしてみましょう。
WorkspacがMy Workspcaeからfreee Public API Workspaceに変わったことがわかります。また個別のAPIコールは鍵マークがついており編集不可になっていることがわかります。
フォークを作成をクリックします。
コレクションをフォークをクリックします。
自分のWorkspaceで作業が可能となっています。
勿論編集可能になっています。
Discussion