VSCode + Swagger で検索すると、Swagger Viewer を勧める記事はたくさん出てくるものの、なぜか OpenAPI (Swagger) Editor の記事が見当たらないので、おせっかいながらヨイショしておく。
Swagger UI でプレビューできるよ
当然のことながら、エディタで Spec を書きながら、Swagger UI でリアルタイムにプレビューできます。
プレビューを ReDoc に変更することもできるよ
拡張機能の設定で、プレビュー用レンダラーに Swagger UI か ReDoc を選択できる。
OpenAPI、Swagger の入力補完が効くよ
入力補完いいですよね。タイプミスも減るし。人類の叡智。
正直、Swaggerのプロパティなんて全然覚えていないのですが、入力補完のおかげで迷わずサクサク書けます。
入力ミスを警告してくれるよ
必須プロパティが足りていない場合や、定義に存在しないプロパティが記述されていた場合などに警告してくれます。
もちろん、SwaggerとOpenAPIのどちらも対応しています。
コードジャンプが便利だよ
左ツールバーに「/API」ボタンが追加され、クリックするとファイルツリーのビューがAPI内のエイリアス一覧に変わります。
Swagger Spec はどうしても長大になり、見通しが悪くなりがちなので、コードジャンプできるのはものすごく助かります。
もちろん、Pathだけでなく各種定義にもジャンプできます。
セキュリティレポート機能があるらしい？
私は使ったことありませんが、そういう機能があるらしいです。
この紫色のボタンがそうらしい。
残念なところ
Codegen できない
Swagger Editor と Sagger UI の機能を備えてるなら、Swagger Codegen の機能もサポートしてほしかった。
Swagger UI のプレビューを保存できない
ひょっとすると方法があるのかもしれませんが、見つけられていません。
結局、SwaggerHub の方が高機能
上記２項目が不満なら SwaggerHub 使えばいいじゃん、という話になりますよね。
けど、ローカルでVSCodeでやりたいんスよ。
プロジェクトデータと一緒にGit管理したいんですよ。