💭

VSCodeでSwaggerのAPIドキュメント書いてサクッとモックを動かしてみる

2020/11/22に公開約900字

WebのSwagger Editorにyamlファイル読み込ませたり、ローカルサーバー環境整えたりが面倒だったので、API仕様書きながらサクッとモック動かせる方法を調べてみた。

複数環境、複数人でやりとりする場合は、きちんとDockerイメージとか用意するのが良さそうだけどここでは割愛。

VSCodeにSwagger Viewerを導入する

yamlファイルをVSCodeで開く

Swagger Viewerをインストール

https://marketplace.visualstudio.com/items?itemName=Arjun.swagger-viewer

Shift + Alt + PでViewer開くと、yamlファイル編集しながらSwagger見れる

サクッとモックも動かせる。

便利。

備考

localhostのポートが被ってるとかモックがうまく動かない場合はPrismとか使えばいいと思う。
Prismだとデフォルトのlocalhostとポートはhttp://127.0.0.1:4010になる。

Windows

C:\>prism-cli.exe mock swagger.yaml

Mac

$ prism mock swagger.yaml

Discussion

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