jiaxing.liao 3aba922beb init: 初始化项目 1 hafta önce
..
servers 3aba922beb init: 初始化项目 1 hafta önce
README.md 3aba922beb init: 初始化项目 1 hafta önce
index.ts 3aba922beb init: 初始化项目 1 hafta önce
openapi2ts.config.ts 3aba922beb init: 初始化项目 1 hafta önce
package.json 3aba922beb init: 初始化项目 1 hafta önce
schema.json 3aba922beb init: 初始化项目 1 hafta önce
tsconfig.json 3aba922beb init: 初始化项目 1 hafta önce

README.md

生成 TypeScript 接口与类型

简要说明:使用@umijs/openapi根据 API 文档(OpenAPI/Swagger)生成对应的 TypeScript 接口与类型,使用 genapi 脚本调用,配置文件参考 openapi2ts.config.js

1. 文件结构(示例)

  • schema.json — OpenAPI 文档
  • openapi2ts.config.js — 生成器配置
  • packages/api-service/src/types/api.ts — 生成结果
  • package.json

2. package.json 脚本

在 packages/api-service/package.json 或仓库根目录的 package.json 中添加:

{
  "scripts": {
    "genapi": "openapi2ts"
  }
}

可使用pnpm运行:

pnpm run genapi

3. 示例配置:openapi2ts.config.js

配置参考链接:https://github.com/781574155/openapi2typescript#readme