Postmanを利用し始める前はターミナルやコマンドプロンプト等からcURL等を利用してAPIを叩いてテストをしていましたが、
このCollection機能を利用し始めてから簡単なテストであっても再利用性などの観点からPostmanでやることが増えましたので、ごく簡単な紹介記事を書いてみます。
記事の対象者
- Postmanを利用したことがない方
- Postman初心者の方（私もそうですが）
この記事で伝えたいこと
- PostmanのCollection機能は便利なので使おう
- 便利なCollectionが出来上がったら同僚にもシェアしてあげよう
- まず対象のサービスに使えるCollectionが公開されていないかどうか調べよう
Collection って何？
（参考) Postman Collections: Organize API Development and Testing
Collectionは一言で言うと「APIの開発、テスト、およびドキュメンテーションを効率的かつ組織的に管理するための強力な機能」です。
Postmanに基本機能として組み込まれている機能です。
通常、PostmanでRequestを送信すると、左側のメニューにある「History」にたまっていくので、後から同じリクエストを送る場合などはそちらからも行うことが出来ますが、Collectionを利用すると複数のリクエストを整理して機能や目的ごとに整理しておくことができます。
また、様々なWeb上のサービスやSaaS等で利用者向けにあらかじめCollectionを用意してくれているものも数多くありますので、そういったものを利用することでまたAPIテストや開発の効率を高めることができます。
Collection を作って使ってみる
詳細については公式ドキュメントを参照。
PostmanのWorkspaceを開き、左側のメニューからCollectionsを選択
「＋」ボタンを押すと新しいCollectionを作成することができます。
新しいCollectionが作成されました。適宜名前を変えて利用します。
「Add a request」を押すとCollectionに新しいRequestを作成することができます。
あとは通常のRequestを設定する時と同様にパラメータを入れてテストするだけです。
私が最近作ったCollectionの例ですが、例えば以下のような感じでわかりやすくまとめておくことができます。
Collection をチームメンバーに共有しょう
作成したCollectionは簡単にシェアできます。
あなたが便利と感じるものは同僚にもきっと便利ですので！
テンプレートを利用してCollectionを作成する
また、Collectionはテンプレートを利用して素早く作ることもできます。
公式ページの下部にテンプレートが紹介されており、こちらから目的にあったものを選んで利用することができます。
自分が利用したいクラウドサービス等向けに用意されたCollectionを利用する
便利なCollectionですが、さらに便利な点としてはAPIが公開されているようなサービスの場合、結構な割合でその開発者やユーザーなどがしっかりとまとめられたCollectionを公開していることが多いことです。
Postmanの上部にある検索窓から既存の公開されているCollectionを探すことができます。
思いつくサービスを検索キーワードに入れてみると、だいたい見つかります。
例えば多くの人が利用するような以下のようなサービスのCollectionなども用意されています。
- DeepL
- ChatGPT (OpenAI)
- Salesforce
- Microsoft Graph
- Box
などなど・・・
QualtricsのCollectionもあります！
体験管理プラットフォームのQualtricsもAPIを利用した他サービスからQualtricsを呼び出したり、また、Qualtrics自身のアンケートフローやワークフローからAPIをCallして様々な処理を行うことができます。
APIリファレンスも公開されており、こちらのリファレンスサイトからAPIを直接Callしてテストすることもできるのですが、Postmanを利用するとさらにテストが楽になります。
その際に役にたつのがQualtrics Public APIsのCollectionです。
以下のページからCollectionを利用することができますので、Qualtricsとのシステム連携を含むシステム開発をされる方などはぜひ活用してください。
Qualtrics Public APIs | Postman API Network
