Postman の導入効果をレビューでご紹介(きょー。- 株式会社エブリー)
株式会社エブリー / Keyl0ve
メンバー / バックエンドエンジニア
導入の背景・解決したかった問題
導入背景
ツール導入前の課題
- APIのレスポンスを確認するのが大変だった
- サービスごとに環境を切り替えるのが大変だった
cURLでリクエストできるように必要なヘッダーやトークンを取得・設定するのが手間で、開発環境と本番環境でヘッダーが異なることや一定時間ごとに有効期限が切れるトークンの再取得など、開発以外の箇所でも時間を取られていました。 また、開発しているサービス的に複数のサーバーを見るのですが、cURLでリクエストするためのベースとなるリクエストをサーバーごとにテキストで保存・管理していたのも大変でした。
どのような状態を目指していたか
- API開発・テスト作業をもっと効率化したい
- 環境間の設定を一箇所で管理したい
- 認証まわりを自動化して楽したい
本来時間を割くべきである開発のみに集中できるような環境を目指していました。
導入の成果
改善したかった課題はどれくらい解決されたか
API開発・テスト作業を効率化、設定の一元管理:解決
- URL、Header情報を変数として一箇所で管理できるようになりました。また、環境の切り替えがワンクリックでできるようになりました。
認証の自動化:解決
- トークンの自動取得・設定で自動化をしました。毎回トークンを取得し直す必要がなくなって楽になりました。
どのような成果が得られたか
設定ファイルをチーム内で管理することによってAPI開発・テスト作業が標準化されました。その結果バックエンドエンジニアだけでなく、クライアントエンジニアなど誰でもレスポンスを簡単に取得・確認できるようになりました。 また、何か問題が起こった時でもすぐにPostmanで該当APIに対してリクエストをして状況を確認できるようになり、どこが問題になってそうかあたりをつけやすくもなりました。
導入に向けた社内への説明
上長・チームへの説明
導入することでAPIリクエスト・レスポンスの確認・管理が簡単になるということを上長に伝え、検証も兼ねてツールを導入することを許可してもらいました。
活用方法
よく使う機能
APIに対してのリクエスト・レスポンス確認
ツールの良い点
1. 変数機能による一元管理
Global、Collection、Environment変数というスコープがあり、用途に応じて使い分けられます。
- 適切に設定することで環境ごとに切り替えが簡単にできる
- 複数のコレクション間で設定を共有できる
- 一箇所変更すれば全部に反映されるのが楽
2. スクリプト機能による自動化
リクエストの前後でJavaScriptで書いたいろんな処理を挟むことができます。
- pre-request scriptとpost-response scriptで前後の処理をカスタマイズ
- 認証トークンの自動更新とか、面倒な作業を全部自動化
- 動的なリクエストパラメータの生成も楽々
3. 豊富なインポート・エクスポート機能
cURLなどで書かれたリクエストも簡単に取り込み、管理することができます。
- cURL形式のリクエストをそのまま取り込める
- OpenAPI仕様書からリクエストを自動生成
- Go、Rustなど他言語へのコード生成もできる
ツールの課題点
学習コスト・慣れるまでの期間
機能自体が色々あるのでどんなことができるのかわかるまで時間がかかりました。例えば、変数のスコープ(Global、Collection、Environment)の使い分けや、pre-request scriptとpost-response scriptの使い所など最初はわかりませんでした。
ツールを検討されている方へ
いきなりチームに導入するのは難しいこともあるかと思います。上長に導入を相談する前に個人で小さく試してみてみることをお勧めします。
今回取り上げた内容は以下のtech blogでも取り上げていますので、不明な点等ありましたら一度お読みいただければなと思います。
株式会社エブリー / Keyl0ve
メンバー / バックエンドエンジニア
よく見られているレビュー
株式会社エブリー / Keyl0ve
メンバー / バックエンドエンジニア
レビューしているツール
目次
- 導入の背景・解決したかった問題
- 活用方法