📝
VScodeでOpenAPIを書くために便利なプラグイン一覧
はじめに
開いていただきありがとうございます。
OpenAPIを書く際はこれまでブラウザ上の「Swagger Editor」を使用していました。
プラグインを入れることでVScodeでも書けることがわかった(おそらく今後は全部VScodeで書くことになるんだろうな・・・)ので、その際に使用したプラグインをまとめてみようと思います。
プラグイン
Swagger Viewer
viewerを開くには以下の方法で行います。
- コマンドパレットから「Preview Swagger」を選択
- shift + option + p
以下のようにSwagger Editorと同じ画面で確認することができます。
また、編集はリアルタイムで更新されます。
openapi-lint
openAPIのドキュメントを検証や静的解析を行ってくれる拡張機能です。
OpenAPI(Swagger) Editor
エクスプロラーにpathやcomponentsが表示されます。クリックするとファイルの該当箇所まで飛んでくれます。
ファイルの量が多くなったときに便利でした。
OpenApi Snippets
openapiのコード補完機能です。よくスペルミスをする人なのでコード補完に頼るようにしています。
終わりに
他にもいいものがあれば随時更新していこうと思います。
Discussion