VSCodeでSwaggerの環境構築

##前提
VisualStudioCodeが導入済み

##目的
VSCodeでSwaggerを書ける状態にする

##インストール
VSCodeにPrettierプラグインをインストールします。

Swagger Viewer のインストール

• Visual Studio Codeを開く
• 画面左部拡張機能をクリックする
• 検索フォームに『Swagger Viewer』と入力し検索する
• 検索結果から『Swagger Viewer』を選択し、インストールする
  

API使用書の作成

• sample.yamlで新規ファイルを作成する

sample.yaml

openapi: 3.0.0
info:
  version: 1.0.0
  title: Swagger sample
paths:
  /users:
    get:
      summary: Usersを取得するAPIです。
      responses:
        '200':
          description: HTTPステータスコード200と以下の情報を含むJSONオブジェクトを返します。
          content:
            application/json:
              schema:
                type: object
                properties:
                  user_id:
                    type: string
                    example: 1

API仕様書のプレビュー
"Shift+Alt+p"でプレビュー表示する

#HTMLファイルとして出力したい場合
redoc-cli を使うとコマンドラインでyamlを静的HTMLに変換できる
前提：nodeがインストールされている必要がある

redoc-cliをインストールする

npm install -g redoc-cli

静的HTMLを生成する

redoc-cli bundle sample.yaml