@fxri/swagger2api 1.0.9 → 1.0.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/.swaggerrc CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "url": "https://kjt.yunhesoft.top/api/admin/v3/api-docs/default",
2
+ "url": "http://develop-daggoo-technology.daggoo-k8s.com/backend/pub/v3/api-docs",
3
3
  "output": "./src/api",
4
4
  "name": "index"
5
5
  }
package/README.md CHANGED
@@ -5,8 +5,8 @@
5
5
  ## ✨ 特性
6
6
 
7
7
  - 🚀 **快速生成** - 从 Swagger JSON 快速生成 TypeScript 接口代码
8
- - 📁 **特性区别** - 利用现有参数拼接了新的 operationId 字段,避免了重名接口会出现【_n】后缀的情况,
9
- - 📝 **拼接规则** - 将接口地址与请求方法拼接作为唯一ID,将不带【{.+}】参数的【get】改为【query】作区分,然后移除【{.+}】参数,并移除地址的第一个参数
8
+ - 📁 **特性区别** - 利用现有参数拼接了新的 operationId 字段,避免了重名接口会出现【_n】后缀的情况
9
+ - 📝 **拼接规则** - 将接口地址与请求方法拼接作为唯一ID,通过可选参数,将不带【{.+}】参数的【get】改为【query】作区分,然后移除【{.+}】参数,并移除地址的第一个参数
10
10
  - ⚙️ **环境依赖** - 工具需要在 node@20 及以上运行时环境下使用
11
11
  - 🔧 **CLI 工具** - 更多参数可查看 swagger-typescript-api 官方文档
12
12
 
@@ -47,23 +47,43 @@ npx swagger2api
47
47
  | `url` | string | - | Swagger JSON 文件路径或 URL |
48
48
  | `output` | string | `'./src/api'` | 生成代码的输出目录 |
49
49
  | `name` | string | `'index'` | 接口文件名称,后缀为ts |
50
- | `config` | string | `'.swaggerrc'` | 配置文件 |
50
+ | `--config,-c` | string | `'.swaggerrc'` | 配置文件 |
51
+ | `--convert-get,-cg` | void | `-` | 转换无{.+}get为query |
52
+ | `--remove-param,-rp` | void | `-` | 移除{.+}参数 |
53
+ | `--remove-prefix-index,-rpi` | number | `-1` | 移除前缀索引 |
51
54
 
52
55
  ## 🔧 CLI 命令
53
56
 
54
57
  ```bash
55
- # 生成接口代码
56
- npx swagger2api [--config <path>]
58
+ # 自定义配置文件
59
+ npx swagger2api [--config,-c <path>]
60
+ ```
61
+
62
+ ```bash
63
+ # 转换无{.+}get为query
64
+ npx swagger2api [--convert-get,-cg]
65
+ ```
66
+
67
+ ```bash
68
+ # 移除{.+}参数
69
+ npx swagger2api [--remove-param,-rp]
70
+ ```
71
+
72
+ ```bash
73
+ # 移除前缀索引
74
+ npx swagger2api [--remove-prefix-index,-rpi <number>]
57
75
  ```
58
76
 
59
77
  ## 📝 PNPM 脚本
60
78
 
61
79
  在 `package.json` 中添加:
62
80
 
81
+ 生成 axios http 客户端,生成有关请求响应的附加信息
82
+
63
83
  ```json
64
84
  {
65
85
  "scripts": {
66
- "api": "swagger2api",
86
+ "api": "swagger2api --axios --responses",
67
87
  }
68
88
  }
69
89
  ```