VSCodeのReDoc Viewerプラグインでプレビューする

VSCodeのReDoc Viewerプラグインでプレビューする

非推奨

現在redoc-cliは非推奨になっています。後継は、@redocly/cliとなっています。

VSCodeのReDoc Viewerプラグインでプレビューする

API GatewayからSwagger +API Gateway 拡張の形式でエクスポートしたファイルからRedoc-CLIで静的ドキュメントを作成する方法 」でRedoc-cliを使って静的HTMLやローカルサーバから表示することを確認しましたが、VSCodeのプラグインでもプレビューすることが可能です。

Swagger ViewerだとSwagger UIがVSCode内に表示されるのですが、ReDoc Viewerプラグインだと、ローカルサーバが起動されて表示されるという仕組みとなっています。

既定ブラウザが立ち上がります。

ReDoc Viewerプラグインを入れて、OpenAPI3.0形式のYamlファイルを表示した状態で「F1」 – 「ReDoc Viewer」でブラウザが起動されます。

VSCodeのReDoc Viewerプラグインでプレビューする

コメント

タイトルとURLをコピーしました