🌠

VSCodeでOpenAPI作成環境を整えるための拡張機能

2023/01/06に公開約1,900字

はじめに

仕事でOpenAPI仕様に沿って、APIドキュメントを作成する機会がありました。
VSCodeに拡張機能をインストールして作成環境を整えたのですが、その時に使った拡張機能をまとめておこうと思います。
拡張機能をインストールしてLintやLive Previewをできるようにします。

なお、OpenAPIの仕様は以下のサイトで確認できます。
https://swagger.io/specification/

インストールした拡張機能たち

OpenAPI (Swagger) Editor

OpenAPI定義ファイルの新規作成、ナビゲーション、参照へのジャンプ、インテリセンス、プレビューなどができます。

openapi-designer

プレビューができます。サイドパネルだけでなく、ブラウザ上に表示することができます。
API開発中などで、ブラウザのデベロッパーツールを使いたい場合に便利かもしれません。

OpenApi Snippets

コード補完ができます。

openapi-lint

ドキュメントに対するバリデーションとリンターを提供してくれます。

Path Intellisense

ファイルパスを入力中に候補を表示してくれます。OpenAPI とは直接関係ありませんが、ファイル分割した際に便利でした。

補足

OpenAPI×VSCodeに関する記事で、よく「Swagger Viewer」という拡張機能が紹介されていると思いますが、ファイル分割に対応していなかったり(2022年8月時点)、プレビュー表示エラー時にエラー箇所がわかりにくかったので、今回は使いませんでした。

Discussion

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