本当は教えたくなかったPostmanの知られざる使い方

どうも、ウェブ系ウシジマくんです。

今回はAPIサーバーにリクエストを送るクライアントアプリとして有名なPostmanの意外と知られていない使い方について紹介していきます。

Postmanのダウンロードはこちら

Postmanをダウンロードする

リクエストした内容とレスポンスを保存できる

Postmanには、APIサーバーに送ったリクエストとそのレスポンスを保存する機能が備わっています。

サイドバーにあるHistoｒｙでも確認はできますが、時系列なので以前の内容をさかのぼりたいときに、若干不便なんですよね。

そんな時に便利なのが、リクエストとレスポンスを保存する機能です。

Sendボタンの右隣にSaveボタンがあるので、クリックしてみてください。

すると、画像のようにモーダルウィンドウが出てくるので、必要な箇所を記入します。

保存に成功すると、サイドバーのcollectionタブに、先程作成したディレクトリ名でリクエストとレスポンスの内容が保存されているのが確認できます。

頻繁にリクエストする内容は、ここに保存しておくと便利ですよ。

保存した内容からAPIドキュメントを作成する

先程紹介したリクエストとレスポンスの保存方法ですが、実はこの内容を応用してAPIドキュメントを作成することができるんです。

方法はとても簡単で、まずはサイドバーに表示されている先程保存したディレクトリ名をクリックします。

クリックすると下記の画像のようなボタンとウィンドウが出現するので、1と2のやり方に従ってボタンを押していきます。

ディレクトリ名ごとに割り振られたURLに遷移すると、下記の画像のような見やすいドキュメントページが表示されるんですね。

リクエストを送るための方法を選択できるようになっていて、2019年2月現在、以下の7つが選択可能。

選択できるリクエスト方法

• cURL
• jQuery
• Ruby
• Python Requests
• Node
• PHP
• Go

個人的には手軽さでいえばSwagger EditorやApiaryよりも扱いやすい印象があるので、個人開発では今後Postmanだけでやろうかな。