YMLib - other - API仕様書作成(Swagger Editor)

API仕様書作成(Swagger Editor)

2025/07/06

Swagger Editorを使ってAPIの仕様書を作ってみます。

「swagger editor」で検索します。

最初に表示されている「Swagger Editor」をクリックします。

cookiesはどちらかを選択。下のポップアップウィンドウは×で閉じました。

左のコードをすべて消したところ、右に「No API definition provided」と表示されました。

左に「openapi: 3.0.4」と入力したら右にエラーが出ました。

左にAPIの仕様を記述してみます。

hello.yaml

1:
2:
3:
4:
5:
6:
7:
8:
9:
10:
11:
12:
13:
14:
15:
16:
17:
18:

openapi: 3.0.4
info:
  title: ymlib API
  version: 1.0.0

paths:
  /hello:
    get:
      summary: "Hello swagger"
      description: "description Hello Swagger"
      responses:
       "200":
         description: "Success"
         content:
           application/json:
             schema:
               type: string
               example: "Hello Swagger"

右にAPIの仕様書が表示されました！

保存しようとしましたが、Swagger Proじゃないとできないようです。

見た目がかなりきれいで良いですね。

関連項目