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

1457 ワード

API Swagger Prism tech テキストリンク

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

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

VSCodeにSwagger Viewerを導入する

yamlファイルをVSCodeで開く

Swagger Viewerをインストール

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

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

便利。

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

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

$ prism mock swagger.yaml

この問題について(VSCodeでSwaggerのAPIドキュメント書いてサクッとモックを動かしてみる), 我々は、より多くの情報をここで見つけました https://zenn.dev/unsoluble_sugar/articles/32e7c43e177fd9273ee3

著者帰属：元の著者の情報は、元のURLに含まれています。著作権は原作者に属する。

Collection and Share based on the CC protocol