Swagger EditorをDockerで起動しVSCodeでOpenAPIを記述する

Swagger EditorをDockerで使う

# 起動
# localhost:80にアクセス
$ docker run -d -p 80:8080 --name editor swaggerapi/swagger-editor:v3.8.2

# 停止
$ docker stop editor

# 消す
$ docker rm editor

VSCodeの拡張機能を使う

Swagger Viewerをインストール
VSCodeでShift+Alt+Pを押すと右側にViewerが現れる
VSCodeを使うと下の感じで観れる.

GETで"Hello World !"を表示するAPIの記述

openapi: "3.0.3"

info:
  title: "Sample API"
  version: "1.0.0"

paths:
  "/message":
    get:
      summary: "Sample API get operation"
      description: "Sample API get operation"
      responses:
        "200":
          description: "Success operation"
          content:
            application/json:
              schema:
                type: string
                example: "Hello World !"