Postmanを使い始めた時に知っておきたかった地味に便利な機能10選

:::note info
技術記事は はてなブログ へお引越ししました。
興味を持ってくださった方は[こちら](https://blog.hatena.ne.jp/ysknsid25/karanohako.hatenablog.jp/subscribe?from_url=https%3A%2F%2Fblog.inorinrinrin.com%2F&utm_source=hatena-follow-button-box&utm_medium=button&utm_campaign=subscribe_blog)をご購読いただければと思います🙏
:::

普段何気に使っているPostman。最近まで「手軽にGUIで疎通を試せて、設定を共有できてべんり〜」くらいで使っていました。

けどふと「実はもっと便利な機能があるのでは？」と思って調べてみたところ、色々出てきたのでせっかくなのでシェアしたいと思います。

たまたまですがちょうど10選！

# 地味に便利な機能10選

## VSCode拡張

PostmanにはVSCode拡張機能があります。

![postman1.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3584722/907ba370-dd58-651e-6049-668968f9869b.png)

インストールするだけで、VSCodeのサイドバーから利用可能です。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3584722/ac6f0479-a85c-8a92-c13d-2b0b5da74524.png)

## 日本語設定

日本人なので日本語で使いたい。

右上の歯車→Settingsから以下の通り選択することで日本語化が可能です。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3584722/2e33df5c-deb9-053b-6cc8-829f041140e3.png)

## 変数の定義

複数のAPIで同じ値を使いたい場合があるとします。例えばテスト用のユーザーIDなどです。

Postmanではそんな値をAPIファイルに逐一ハードコードする必要はなく、変数に保存することが可能です。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3584722/83a9b71d-58ec-26db-bd49-f684e20082c6.png)

## Postman Echo

これはあまり用途がないのですが、先ほどのように変数にに定義された値を確認することができる機能です。

試しに先ほど定義してみた`hoge`が`ほげ`と出力されるかを確認してみます。

エンドポイントに`http://postman-echo.com/get`を指定すると利用できます。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3584722/a345c360-f129-d707-527f-7602d39f61f2.png)

## Fakerの利用

適当な氏名や電話番号、氏名などをパラメーターとしてAPIを実行したい場合などがあります。

その場合、動的に利用可能な変数を使うと便利です。

以下のページに利用可能な値が掲載されています。

https://learning.postman.com/docs/writing-scripts/script-references/variables-list/

例えば以下のように、適当な氏名を入力することができます。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3584722/3253f5d8-b581-ff91-9a39-25d558b6e1a2.png)

## 2分割表示

ところでみなさん、「Postmanのレスポンスが下にあるのちょっと見づらいな〜」と思ったことはありませんか？

そんなときはPostmanを2分割表示することで、個人的には収まりが良く見やすくなるかと思っています。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3584722/10d52645-2a1f-197b-0af3-13fe60bd5db4.png)

## ドキュメントを書く

簡単にドキュメントを書いておくことができます。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3584722/59606a19-0541-6669-9771-cf4c2c39d3b7.png)

### OpenAPIからimport

昨今ではOpenAPIでAPIドキュメントを管理している人も多いでしょう。

そんなときは、OpenAPIにて定義した`yaml`もしくは`json`をPostmanにインポートするだけで、APIを実行する準備が整います。

インポート > `yaml` or `json`を選択 > OpenAPI~~~ を選択です。

インポート後はOpenAPIで定義したドキュメントが反映されるので、いちいちOpenAPIの定義を見る必要がなくなります。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3584722/c2f69a88-f2f5-540b-a0a2-397249d651bf.png)

## curlコマンドでの出力

たまに`curl`でAPIを実行する場合があります。そんなときでもPostmanなら勝手にコマンドを生成してくれるので安心です。

`</>`マークを押すだけで簡単に確認できます。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3584722/81051d00-e095-8cd8-338c-485dcd5b1f58.png)

## 複数リクエストの実行(コレクションランナー)

定義したAPIを複数選択後に繰り返し回数・遅延時間を指定して実行し、実行結果を確認することができます。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3584722/1e031827-f97d-3b65-2228-89ffb2c2ed37.png)

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3584722/498cb9b3-e5f7-1b08-b3bb-fff3af436424.png)

## パフォーマンステスト

デスクトップアプリ版のみの機能ですが、簡単なパフォーマンステストもPostmanで実行することができます。

先ほどのコレクションランナーの機能を選択し、「負荷のかけ方」「仮想ユーザー(上限100)」「負荷をかける時間」を入力し実行します。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3584722/130bf3b7-53ec-fb54-9a5e-1e6298484ba3.png)

実行結果がこちらです。グレーの線がユーザー数です。青線がレスポンス速度、赤線がエラー率です。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3584722/7b07d749-ccdf-871f-1875-b5859b3cb4cf.png)

# おわりに

とりあえず思いつく部分だけを書き殴ってみました！

本家のドキュメントを読んでると、まだまだ知らない機能がありそうなので、「これも便利だよ！」という機能があれば是非教えてください！

## 📢 Kobe.tsというTypeScriptコミュニティを主催しています

フロント・バックエンドに限らず、周辺知識も含めてTypeScriptの勉強会を主催しています。

毎朝オフラインでもくもくしたり、神戸を中心に関西でLTもしています。

盛り上がってる感を出していきたいので、良ければメンバーにだけでもなってください😣

https://kobets.connpass.com/