openapi.ymlを簡単に作成する方法

概要

プロジェクトでメンテされていないopenapi.ymlの更新を依頼され、絶望的な気分になりました。
ふと思い立ってchatGPTを利用したら便利だったので、やり方を保存します。

自分は普段openapi.yml(swagger)をいじる機会はないので初心者が便利だと思った方法になります。

結論

1.postmanで動作確認
2.postmanからcurlコマンドを作成
3.chatGPTにopenapi.ymlに変換してもらう

postmanで動作確認

今回対象となったAPIが元々自分の関わったものではないので動作確認から行いました。

postmanからcurlコマンドを作成

例として適当にユーザー作成できそうなエンドポイントを作りました。
そしたら画像赤枠のコードスニペットみたいなアイコンを押します。

curlコマンドが表示されるのでコピーします。

chatGPTにopenapi.ymlに変換してもらう

あとは雑にchatGPTに依頼するだけでopenapi.ymlが出来上がります。
(認証情報などは適当な値を書いています)

chatGPTが生成してくれた全文は下記の通りになります。
実用として問題無いレベルのものが出力されていると思います。

openapi: 3.0.0
info:
  title: Example API
  description: Example API using OpenAPI 3.0
  version: 1.0.0
servers:
  - url: http://localhost/api/v1
paths:
  /users:
    post:
      summary: Create a new user
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                user:
                  type: object
                  properties:
                    name:
                      type: string
                    email:
                      type: string
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
      security:
        - APIKeyAuth: []
        - BearerAuth: []
securitySchemes:
  APIKeyAuth:
    type: apiKey
    in: header
    name: API-KEY
  BearerAuth:
    type: http
    scheme: bearer