APIファーストの開発を進めるにあたってmockサーバーの用意に余計な手間をかけてしまってないでしょうか？
Postmanを利用すれば簡単にmockの準備が完了するのでその手順を紹介します。
APIのmockサーバーの作成手順
APIの定義
左ペインのAPIsタブからCreate an APIをクリックすると下の画面が表示されるので、API名とバージョンを入力します。
既存のAPI定義ファイル(swaggerドキュメントなど)がある場合はimportタブから読み込み可能です。
新規にAPIを定義する場合は、DefineタブでAPIを定義します。
ここではAPI作成時にデフォルトで定義されているペットストアAPIを利用します。
Mockサーバーの立ち上げ
APIの定義が出来たらmockサーバーを起動します。
同じ画面のDevelopタブのAdd Mock Serverをクリックします。
まずは、mockサーバーのレスポンスを定義するcollectionを作成する必要があります。
Create from API schemaのタブをクリックして任意のcollection名を設定します。(例ではtest collection)
次にmockサーバーの設定を行います。任意のmockサーバー名を入力しましょう。(例ではtest mock)
今回はパブリックなモックサーバーとして作成するのでoptionalは何もチェックを入れずに次に進みます。
mockサーバーへリクエストを送る
mockサーバーを建てたらCollectionsタブの作成したcollectionをクリックします。(例ではtest collection)
表示される画面のVariablesタブをクリックすると、ベースURLが変数に定義されていることが確認できます。
この値はAPI定義のserverの項目のものが反映されていますが、今回はmockに接続したいのでこの値をmockサーバーのURLに変更します。
mockサーバーのURLは画面左のMock Serversをクリックして、自分が立てたサーバーの欄にCopy Mock URLをクリックするとコピー可能です。
これで準備は完了です！試しにリクエストを送るとレスポンスが正常に返ってくることを確認できます。
まとめ
この記事ではPostmanを使ってAPI mockを簡単に作成する方法を紹介しました。
コメント