APIのスタブを作成したいです。。。

Question

前提・実現したいこと

APIのスタブを作成したいです。API仕様書は作成済みです。

色々検索した結果、スタブが「レスポンスを返す機能が未実装の状態でテストする時に、その代用として使うもの」
であることくらいしか掴めておりません。

レスポンスの内容が含まれたファイルを作るってことでしょうか。

またその際に何が必要になってくるのでしょうか。

API、swaggerなど先日学んだばかりで理解が追い付いていないため、
分かりにくい質問文になっているかと思います。恐れ入ります。

参考になるサイト等も教えて頂けると幸いです。
よろしくお願いいたします。

Answer 1

API仕様書が具体的にどのように記載されているかわからないので具体的な回答は難しいですが、
スタブやモックと呼ばれるものはおっしゃるとおりテストのための代用です。

API定義はあるのですから、 API通りのエンドポイント（ /api/v1/users/xxx のようなパス)にアクセスすると決められた形式の固定のデータを返してくれるだけのダミーサーバーを作れば良いと思います。

レスポンスの内容が含まれたファイルを作るってことでしょうか。

作っても良いです。
ただ、ファイルに直接アクセスするというより、ダミーのAPIサーバーを通じてそのファイルの内容を返すようにする必要があります。
どんなものでも良いので、サーバーを作ってください。

拙作の記事で結構古いので参考になるかはわかりませんが、 Swagger のYAML定義からNode.jsのスタブサーバーを作る方法を記載しています。
https://mather.hatenablog.jp/entry/swagger-mock

Comments

[99say]

ご丁寧な回答ありがとうございました！