PostmanのMockServerを使ってみる
この記事は、全世界2,800万人以上の開発者に使われているAPIプラットフォームPostmanの記事を書こう by Postman Advent Calendar 2023 のシリーズ2 24日目の記事です。
株式会社dottでバックエンドエンジニアをしているとみぎと申します
今回は、Postmanのコレクション機能をゴリゴリ使ってきた私ですが、なかなか触ることのなかったモックサーバー機能が非常に便利だったので、その紹介をしたいと思います。
TL;DR
- モックサーバーを作ることで、APIの実装をする前に設計や仕様の
- モックサーバーを作る方法は新規で作成する方法と、既存のリクエストから作成する2つの方法がある
- モックサーバーのレスポンスパターンを複数設定することで、レスポンスコード毎の値を返却するなどの設定が可能
Postmanのモックサーバーについて
Postmanのモックサーバー機能は、API開発の初期段階で非常に役立つツールです。
この機能を使用すると、実際にAPIを実装する前に、APIのエンドポイントの設計レビューやテストを行うことができます。
もう少し深掘りすると、特定の仕様に沿ったレスポンスを返すように設定されたエンドポイントを簡単に作成・公開することができます。
これにより、フロントエンド開発者やテスターは、バックエンドのAPIが完成する前に作業を進めることができます。
モックサーバーを作ってみる
早速モックサーバーの作り方なんですが、作成パターンとしては以下の2つがあります。
- 新しいコレクションから作成する
- 既存のコレクションから作成する
この2つのパターンについて順番に説明していきます。
新しいコレクションから作成する
新規で作成する場合は、以下の手順で作成できます。
- サイドメニューのモックサーバーをクリック
- ＋マークをクリック
- 「モックサーバーを作成」というタブが表示されるので、「新しいコレクションを作成」を選択
- モックAPIのURLとレスポンスコード・レスポンスボディを入力
- 「次に進む」をクリック
- モックサーバーの名前を入力
- 必要に応じてその他の設定も追加する
- 「モックサーバーを作成」をクリック
はい、できました！
モックサーバーの作成が完了すると、コレクションのリストに先程設定したモックサーバーのリクエストも自動で追加されるので、そのままリクエストを送信することができます。
リクエストを送信すると、モックサーバーの設定で指定したレスポンスが返ってきます。
なんとまあ、簡単なんでしょう！
既存のコレクションから作成する
はい、続いては既存コレクションから作成する方法です。
こちらは、最初にコレクション機能の方でリクエストを作成してた場合に使えます。
事前準備として、予めコレクションからリクエストを作成して、リクエストのURLやリクエストパラメータ、レスポンスパラメータのサンプルを登録しておきます
モックサーバーの作成画面表示までは、新規コレクションから作成と同じです。
今度はモックサーバーの作成タブから以下の操作を行います
- 「既存のコレクションから作成」を選択
- モックサーバー化したいコレクションを選択
- モックサーバーの名前を入力
- 必要に応じて環境などの設定を行う
- 「モックサーバーを作成」をクリック
はい、できました！
あとは既存のコレクションのURLを更新してリクエストを送信するだけです。
その他
上記で触れたのはモックサーバーのほんの一部の機能でしかありません。
その他にも
- モックサーバーをAPIキー認証をつけてプライベートで公開
- リクエスト・レスポンスのサンプルをレスポンスコードごとに設定し、複数パターンのレスポンスを返す
- ネットワーク遅延のシュミレート
などなど、まだまだ便利機能がたくさんあります。
まとめ
以上がPostmanのモックサーバーについての紹介になります。
繰り返しになりますが、Postmanのモックサーバーの機能を使うことで、APIの仕様を確認することができますし、フロントエンド開発者やテスターは、バックエンドのAPIが完成する前に作業を進めることができ、開発の効率化につながるのでぜひ使ってみてください！
Discussion