初めに

名前だけは聞いていたPostmanを使ってみた記事です。Postmanの達人ではなく、Postmanって何?という方に向けた記事になります。

Postmanって何?

API developer用の開発ツールです。リクエストパラメータや認証情報などを任意に設定してAPIの呼び出すことができます。curlのIDEみたいな感じですね。

https://www.postman.com/

Postmanの何がすごそうなの?

APIリクエストのパラメータ等を管理できる

こんな感じで image.png

それぞれはこんな感じ image.png

開発するAPIの仕様に合わせて、Authorizationも設定できます。

image.png

例えばx-api-keyを設定する必要があるとか、Bearer Tokenが必要ですとか、お手元の要件に合わせて設定しましょう。

接続先などを環境変数として設定できます。

image.png

詳しくは

https://learning.postman.com/docs/sending-requests/managing-environments/

なので、ベースのリクエストパターンを用意して、例えばローカル用、例えばSTG用といった形で接続先だけ分けるといったことが可能です。

リクエスト結果をテストするScriptを書ける

こんな感じで

image.png

これはresponseのステータスと返却内容のobjectが正しいかを確認しています。

pre-request scriptもあるので前処理もできるはず(例えば認証しないと使えないAPIのために認証をするとかできるはず)

諸々設定した値をjsonファイルに書き出せる

image.png

ということは

git管理できる

consoleから呼ぶライブラリもあります。

https://www.npmjs.com/package/newman

お試ししてみたい

お試し用サーバとnewman用のjsonファイルを格納したレポジトリを作りました。 READMEに書きましたが、各種コマンドを打つことでサーバを立てたり、newmanでリクエストしてみたりできます。

https://github.com/pbuchihori/postman-sample

記事一覧に戻る