swagger

swagger yaml → html変換メモ


前提条件

visual studio codeのインストールが完了していること


拡張機能をインストールする

visual studio codeに、以下の拡張機能をインストールする


  • Swagger Viewer

  • swagger-doc-viewer

  • swaggitor


Swagger Viewer で viewer を確認する

yamlファイルをvisual studio codeで開き、以下の方法でSwagger Viewerを使用し、viewerを確認する

1. [F1]押下後、検索ボックスで「Preview Swagger」を検索し、選択

2. Shift + Alt + P


Markdownファイルをプレビューで確認する


  1. ファイルの上で右クリック

  2. プレビューを開く


yamlファイルからhtmlファイルへ変換する

$ npm install -g bootprint

$ npm install -g bootprint-openapi
$ bootprint openapi <出力したYAMLかJSONファイル> <出力先ディレクトリ>