🌲

Prism を使って OpenAPI の定義を元に値を返してくれるモックサーバーを建てる

2021/06/24に公開約1,000字

モックサーバー便利ですよね。
バックエンドとフロントエンドを実装する人が分かれている時は特に。

ですが一々エンドポイントごとの定義とか値を設定するのめんどくさい…!
という訳で OpenAPI の定義を元にいい感じのデータ返してくれるものないかなーと探していたところ以下の Prism というものを発見したので紹介します。

https://meta.stoplight.io/docs/prism/README.md

インストール

npm install --save-dev @stoplight/prism-cli

package.json に実行のためのコマンドを追加します。

"scripts": {
  "run:mockserver": "prism mock ./openapi.yml"
},

実行する

実行するとこんな感じでモックサーバーが建てられました。ちゃんと OpenAPI の定義通りのエンドポイント達です。

リクエストを実行すると次のように定義通りの値が返ってきました。
中身はアレですがとりあえず型通りのものが返ってくるので満足ですね。

ちなみに OpenAPI の方に example というのを足してあげれば、それを返してくれるようになるみたいです。もう少しちゃんとデータを表示したい場合に使うと良さそうですね。

https://meta.stoplight.io/docs/prism/docs/guides/01-mocking.md

Discussion

ログインするとコメントできます