Postmanツールの機能紹介


エンジニアのクオンです。

今回は、業務でよくお世話になっているPostmanについて紹介させて頂きます。

Postmanとは

Postmanは、Web APIのテストクライアントサービスのひとつです。色々なクライアントの動きをテストできるようスクリプト拡張や、テストスイートシナリオの作成などの機能があります。Postmanで、認証、テスト、ドキュメント作成、バージョン管理などAPIの多くの要素を統合して開発できる環境で、API設計・開発にはとても助かります。

Chrome AppとMacアプリが用意されています。(アプリの方がオススメです)
以下はアプリ版です。

次は基本の機能をご紹介します。

リクエストする

Postmanで簡単にAPIリクエストを送信し、レスポンスが取得できます。
以下はGET APIの例です。

API接続方法指定する

HTTPメソッド: HTTPメソッドを選択。選択できるのが多いですが、GET / POST / PUT / DELETEが良く使われています
URL: APIのURLを記載する
Params: URLパラメータを設定する(key-value形で)
Send: APIを実行する
Save: 接続情報を保存する

タブの紹介

Authorization

ここでは認証方式を選択することができます。
対応しているのが以下です。
Basic Auth / Digest Auth / Bearer Token / OAuth / AWS Signature

Headers

HTTP ヘッダー情報をKey-Value形で入力できるところです。
一般のHTTPヘッダー(Content-Type, Content-Length, Acceptなど)を全て設定可能です。
カスタムヘッダの値なども定義できます。(APIキーの独自ヘッダーなどをここで定義します。)

Body

POSTやPUTのリクエストボディをここで定義します。
form-data、x-www-form-urlencoded、raw、binary選択があって、
JSON データ、XMLデータ、HTTPフォームのデータなど定義できます。

Pre-request Script

リクエスト実行前に実行されるスクリプトです。Javascriptで書けます。
例えば、ランダムな値をURLパラメーターに追加、またはタイムスタンプをリクエストヘーダーに追加など

次はPostmanの便利な変数セットについてご紹介します。

変数セット(Environment)

開発には様々な環境(ローカルホスト、development, staging, productionなど)があります。
環境によって、上記のURL,Paramsの値などが異なるので、普通は書き直す必要ですが、Postmanの変数と変数セットを使うと、書き直しは不要で、変数を切り替えることで、様々な環境へ切り替えることができます。

まずはURL, paramsに固定の値の代わりに、変数で定義します。
syntaxは{{変数名}}です。

変数の値を変数セットで定義・保存できます。
下記locahostとstaging変数セットを作ります。
変数セットを切り替えてあげると、セットの中の変数に入れ替わります。

変数セットを追加、作成、共有(チームに)、削除を行うことができますが、共有は有料版でしかできません。

まとめ

Postmanの機能を一部紹介させてもらいました。
上記の機能以外、便利な機能がまだたくさんあります。
– コレクションモニタリング
– コレクションのドキュメントを自動生成・公開
などなど
Postmanはとても便利なツールですので、ぜひ使ってみてください。
有料版は、シナリオや変数セットを自動的にSyncし、メンバー間でコレクション・変数セット共有できるなどの機能がありますが、無料版でも充分だと思います。

以上です。
リンクバルではエンジニアを積極的に募集中です。興味のある方は、こちらまでご応募ください。