概要

未作成（いつか生成AIでSwaggerの利点や何ができるかをまとめる）
使用方法としてWebアプリだったりVScodeの拡張機能だったりいろいろある話も。

簡易的な使用方法

VScodeへの拡張機能ダウンロード

OpenAPI (Swagger) Editorをインストールする

サンプルファイル(.yml)の用意

下記のファイルを「swagger.yml」として用意する。

openapi: 3.0.0
info:
  title: Sample Hello API
  description: A simple API that returns a greeting.
  version: 1.0.0

paths:
  /hello:
    get:
      summary: Returns a greeting message.
      responses:
        '200':
          description: A successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Hello, world!

VScodeでのプレビュー

1. 対象のswagger.ymlをVScodeで開く
2. 左下の歯車からコマンドパレットを開き、下記を実行。