@easyv/swagger-api-types
v0.1.2
Published
根据 `Swagger` 文档生成 `ts` 类型。
Downloads
3
Maintainers
Keywords
Readme
类型生成工具
根据 Swagger
文档生成 ts
类型。
使用方式
1. 安装依赖
npm install @easyv/swagger-api-types -D -E
或者
pnpm install @easyv/swagger-api-types -D -E
2.添加配置文件
在根目录添加配置文件,配置文件的类型,目前只支持json
。
默认配置文件 swagger.config.json
./swagger.config.json
{
"url": "xxx", // swagger api 接口文档json地址,注意不是文档地址,一般是后缀docs-json
"rootDir": "./src", // 项目根路径地址,可不填,默认值为 "./src"
"override": "./swagger-override.ts" // 覆盖swagger类型的文件,可选
}
3.添加命令
在 package.json
中添加一个脚本
...
scripts: {
"types": "easyv-types --config swagger.config.json"
}
...
4.执行命令
npm run types
或
pnpm types
5.最终结果
最后会在项目目录下生成一下文件:
src/types
目录下生成api.swagger-schema-types.ts
和api.swagger-types.ts
文件src/constants
目录下生成api.swagger-constants.ts
。
注意:生成的文件默认不允许改动,因为一旦改动了,下次生成的时候会被覆盖,改动就无效了。