@fxri/swagger2api 1.1.1 → 1.1.2
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/README.md +18 -12
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,25 +4,31 @@
|
|
|
4
4
|
|
|
5
5
|
## ✨ 特性
|
|
6
6
|
|
|
7
|
-
- 🚀 **快速生成** - 从 Swagger JSON 快速生成 TS/JS
|
|
8
|
-
- 📁 **特性区别** - 利用现有参数拼接了新的 operationId 字段,避免了重名接口会出现【_n
|
|
9
|
-
- 📝 **拼接规则** - 将接口地址与请求方法拼接作为唯一ID,通过可选参数,将不带【{.+}】参数的【get】改为【query】作区分,然后移除【{.+}
|
|
10
|
-
- ⚙️ **环境依赖** - 工具需要在 node@20
|
|
11
|
-
- 🔧 **CLI 工具** - 更多参数可查看 swagger-typescript-api
|
|
7
|
+
- 🚀 **快速生成** - 从 Swagger JSON 快速生成 TS/JS 接口代码。
|
|
8
|
+
- 📁 **特性区别** - 利用现有参数拼接了新的 operationId 字段,避免了重名接口会出现【_n】后缀的情况。
|
|
9
|
+
- 📝 **拼接规则** - 将接口地址与请求方法拼接作为唯一ID,通过可选参数,将不带【{.+}】参数的【get】改为【query】作区分,然后移除【{.+}】参数,并移除地址的第一个参数。
|
|
10
|
+
- ⚙️ **环境依赖** - 工具需要在 node@20 及以上运行时环境下使用。
|
|
11
|
+
- 🔧 **CLI 工具** - 更多参数可查看 swagger-typescript-api 官方文档。
|
|
12
12
|
|
|
13
13
|
## 💡 功能简介
|
|
14
14
|
|
|
15
15
|
### 快速模式
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
1.直接使用配置文件参数,若配置文件不存在或者参数不全(如第一次运行该工具),则不会进入该模式。
|
|
18
18
|
|
|
19
19
|
### 指定配置
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
1.指定配置文件路径,支持多选,用【,】分隔。
|
|
22
|
+
|
|
23
|
+
2.使用该参数则不会触发扫描全部配置文件功能。
|
|
22
24
|
|
|
23
25
|
### 多文档配置
|
|
24
26
|
|
|
25
|
-
|
|
27
|
+
1.默认配置文档为saconfig.json,项目启动后会扫描当前项目下的所有符合【./**/saconfig*.json】规则的文件(如【saconfig.json】【saconfig.admin.json】【config/saconfig.json】等),并在扫描到多个文件是提供选择列表,如只有一个文件,则直接进入下一步,该功能可在配置项中关闭。
|
|
28
|
+
|
|
29
|
+
2.此功能扩展使用的话,可以作为一个独立工具使用,同时管理多个项目的接口配置。
|
|
30
|
+
|
|
31
|
+
3.搭配上快速模式和加载全部配置文件参数,可以实现一行命令更新所有项目的接口配置。
|
|
26
32
|
|
|
27
33
|
## 📦 安装
|
|
28
34
|
|
|
@@ -54,7 +60,7 @@ yarn add @fxri/swagger2api
|
|
|
54
60
|
|
|
55
61
|
在 `package.json` 中添加:
|
|
56
62
|
|
|
57
|
-
生成 axios http
|
|
63
|
+
生成 axios http 客户端,生成有关请求响应的附加信息,移除第一个前缀索引,使用快速模式。
|
|
58
64
|
|
|
59
65
|
```json
|
|
60
66
|
{
|
|
@@ -74,7 +80,7 @@ yarn add @fxri/swagger2api
|
|
|
74
80
|
|
|
75
81
|
### 1. 生成接口代码
|
|
76
82
|
|
|
77
|
-
如果没装过其他名字叫 swagger2api 的工具,那么在 shell 中直接使用就行,如果装过同名工具,则需要带上 @fxri
|
|
83
|
+
如果没装过其他名字叫 swagger2api 的工具,那么在 shell 中直接使用就行,如果装过同名工具,则需要带上 @fxri 作用域。
|
|
78
84
|
|
|
79
85
|
```bash
|
|
80
86
|
npx swagger2api
|
|
@@ -107,7 +113,7 @@ const api = new Api()
|
|
|
107
113
|
api.getUsers().then((res) => console.log(res))
|
|
108
114
|
```
|
|
109
115
|
|
|
110
|
-
每个方法会返回 Promise,可通过 async/await 或 .then()
|
|
116
|
+
每个方法会返回 Promise,可通过 async/await 或 .then() 处理响应。
|
|
111
117
|
|
|
112
118
|
## ⚙️ 配置选项
|
|
113
119
|
|
|
@@ -117,7 +123,7 @@ api.getUsers().then((res) => console.log(res))
|
|
|
117
123
|
| `output` | string | `'./src/api'` | 生成代码的输出目录 |
|
|
118
124
|
| `name` | string | `'index'` | 接口文件名称,默认后缀为ts |
|
|
119
125
|
| `--quick,-q` | boolean | `false` | 快速模式,直接使用配置文件参数,不再二次确认参数 |
|
|
120
|
-
| `--config,-c` | string | `'saconfig.json'` |
|
|
126
|
+
| `--config,-c` | string | `'saconfig.json'` | 填写配置文件路径,支持多选,用【,】分隔 |
|
|
121
127
|
| `--config-all,-ca` | boolean | `false` | 加载全部配置文件,不进行选择 |
|
|
122
128
|
| `--config-scan,-cs` | boolean | `true` | 扫描全部配置文件,并提供选择列表 |
|
|
123
129
|
| `--convert-get,-cg` | boolean | `false` | 转换无{.+}get为query |
|