1.1.2 • Published 2 years ago
bd-port v1.1.2
描述
基于北斗 Swagger 生成的 json 文件生成 TS 语言的 Api 脚本
依赖
Axiosmd5prettier
Install
npm install bd-port
or
yarn add bd-portUsage
//执行
npx port
//会在项目根目录生成create-bd-api.js
//可以自由配置一些生成相关内容create-bd-api.js 配置项
具体配置项介绍如下：
| 参数 | 值类型 | 描述 | 默认值 |
|---|---|---|---|
| outputDir | string | 生成代码的存放路径 | /src/client |
| enumSign | string | 用什么标记改类型是枚举 | enum |
| enumIsUnify | boolean | 枚举是否统一存放 | true |
| baseUrl | string | Swagger 请求地址 | localhost:3000 |
| list | string[] | Swagger 请求地址。最终的 url 是 baseUrl+listi | [] |
| cache | boolean | 是否缓存，true 会生成 port.lock.json | false |
| version | string | Swagger 版本 V2/V3 | V2 |
| platform | string | 目标平台 PC或者App或者WeChat | ToB/PC |
| prettierUrl | string | 生成文件格式化规则 | /.prettierrc.yml |
| GenerateClass | class | 自定义 Code 生成器 | 脚本生成 |
GenerateClass 配置项
具体配置项介绍如下：
apiTemplate
描述：生成单个 Api 文件的模板
| 参数 | 描述 |
|---|---|
| api | 接口信息 |
| usedModel？ | 接口依赖模型 |
| usedEnum？ | 接口依赖枚举 |
| moduleName？ | 当前 Api 所在模块名 |
| swaggerjson？ | Swagger 全部信息 |
apiIndexFile
描述：生成模块 Api 主入口
| 参数 | 描述 |
|---|---|
| apis | 所有接口信息 |
| moduleName？ | 模块名 |
| usedModel？ | 依赖模型 |
| usedEnum？ | 依赖枚举 |
getRequest
描述：生成单个 Api 文件的模板中的 Request
| 参数 | 描述 |
|---|---|
| request | 当前接口 Request 信息 |
transformData
描述：生成单个 Api 文件的模板中的 Params
| 参数 | 描述 |
|---|---|
| api | 接口信息 |
aliasModelName
描述：type 和 menu 的重命名
| 参数 | 描述 |
|---|---|
| name | type 或 menu 的原始名称 |