type-to-openapi

TypeScriptの型定義からOpenAPI SchemeのScheme部分を生成するコード.

入力になるAPIの型定義

export type PingResponse = {
  body: string;
  status: 'ok' | 'ng' | 1;
  nullableParameter?: string;
}

export type CommentResponse = {
  text: string;
}

実行

# input
npm run generate examples/types.ts -o schemes.json

# output

> type-to-openapi@1.0.0 generate
> npx tsc src/command.ts src/index.ts && node src/command.js schemes.json

Successfully generated to "schemes.json"

出力 + フォーマットしたスキーマファイル

{
  "components": {
    "schemes": {
      "PingResponse": {
        "title": "PingResponse",
        "required": [
          "body",
          "status"
        ],
        "type": "object",
        "properties": {
          "body": {
            "title": "PingResponse",
            "type": "string"
          },
          "status": {
            "title": "PingResponse",
            "type": [
              "ok",
              "ng",
              1
            ]
          },
          "nullableParameter": {
            "title": "PingResponse",
            "type": "string"
          }
        }
      },
      "CommentResponse": {
        "title": "CommentResponse",
        "required": [
          "text"
        ],
        "type": "object",
        "properties": {
          "text": {
            "title": "CommentResponse",
            "type": "string"
          }
        }
      }
    }
  }
}

生成したファイルを使って OpenAPI の API 部分とかを作ると楽そう. それも自動化できないかな.

npm packageで利用する

npm i -D @ihch/type-to-openapi --registry=https://npm.pkg.github.com/ihch

./node_modules/.bin/type2openapi types.ts

TODO

• 対応していない型がたくさん
• 別で定義した型を参照したときに OpenAPI の Refs で引っ張ってくるようにする