@fxri/swagger2api 1.2.6 → 1.2.8
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/CHANGELOG.md +54 -26
- package/NOTICE +9 -9
- package/README.md +55 -169
- package/package.json +7 -2
package/CHANGELOG.md
CHANGED
|
@@ -1,10 +1,34 @@
|
|
|
1
1
|
# @fxri/swagger2api
|
|
2
2
|
|
|
3
|
+
## 1.2.8
|
|
4
|
+
|
|
5
|
+
> 2026-09-15 发布
|
|
6
|
+
|
|
7
|
+
### ⚡ 优化改进
|
|
8
|
+
|
|
9
|
+
- CHANGELOG 统一为 toolkit 现行口径——分组标题改用 9 语义槽位命名,条目剥离冗余类型前缀(类型已由分组标题承接)
|
|
10
|
+
|
|
11
|
+
## 1.2.7
|
|
12
|
+
|
|
13
|
+
> 2026-09-06 发布
|
|
14
|
+
|
|
15
|
+
### ✨ 新增功能
|
|
16
|
+
|
|
17
|
+
- 新增 VitePress 文档站(GitHub 与 GitLab Pages 双端自动部署)
|
|
18
|
+
|
|
19
|
+
### 🐛 问题修复
|
|
20
|
+
|
|
21
|
+
- 全面核对文档与实现一致性,修正无效命令示例(`--quick,-q` 连写、npx 裸名等)与偏差描述,统一 npx 作用域全名口径
|
|
22
|
+
|
|
23
|
+
### 📝 文档更新
|
|
24
|
+
|
|
25
|
+
- README 重构为橱窗式分层设计并重新生成 og-image
|
|
26
|
+
|
|
3
27
|
## 1.2.6
|
|
4
28
|
|
|
5
29
|
> 2026-09-06 发布
|
|
6
30
|
|
|
7
|
-
###
|
|
31
|
+
### ⚡ 优化改进
|
|
8
32
|
|
|
9
33
|
- 升级生产依赖 glob 至 v13,修复依赖漏洞与 deprecated 告警,CLI 行为无变化
|
|
10
34
|
|
|
@@ -12,7 +36,7 @@
|
|
|
12
36
|
|
|
13
37
|
> 2026-09-05 发布
|
|
14
38
|
|
|
15
|
-
###
|
|
39
|
+
### ⚡ 优化改进
|
|
16
40
|
|
|
17
41
|
- 发布清单补充 CHANGELOG.md 与 LICENSE,npm 包内可直接查看更新日志与许可信息
|
|
18
42
|
|
|
@@ -20,15 +44,15 @@
|
|
|
20
44
|
|
|
21
45
|
> 2026-09-04 发布
|
|
22
46
|
|
|
23
|
-
###
|
|
47
|
+
### ⚡ 优化改进
|
|
24
48
|
|
|
25
|
-
-
|
|
49
|
+
- 移除项目内 @fxri/toolkit 依赖,工程化能力(任务管理、变更集、发版)统一改用全局安装的 toolkit(1.6.1),包产物无任何变化
|
|
26
50
|
|
|
27
51
|
## 1.2.3
|
|
28
52
|
|
|
29
53
|
> 2026-09-04 发布
|
|
30
54
|
|
|
31
|
-
###
|
|
55
|
+
### 📦 其他变更
|
|
32
56
|
|
|
33
57
|
- 同步重发:内容与 1.2.2 完全一致(1.2.2 发版后远端冲突回滚,经 cherry-pick 线性重放重新合入 master,本版以新版本号重发),无新增功能改动
|
|
34
58
|
|
|
@@ -36,17 +60,21 @@
|
|
|
36
60
|
|
|
37
61
|
> 2026-09-04 发布
|
|
38
62
|
|
|
39
|
-
###
|
|
63
|
+
### ⚡ 优化改进
|
|
64
|
+
|
|
65
|
+
- 升级 @fxri/toolkit 至 1.6.1(含 tasks archive 双重 CR 换行修复)
|
|
66
|
+
|
|
67
|
+
### 📝 文档更新
|
|
40
68
|
|
|
41
|
-
-
|
|
69
|
+
- 更新方弦 ® 注册商标信息(商标状态由申请中更新为已核准注册,第 42 类注册号 89648411)
|
|
42
70
|
|
|
43
71
|
## 1.2.1
|
|
44
72
|
|
|
45
73
|
> 2026-09-03 发布
|
|
46
74
|
|
|
47
|
-
###
|
|
75
|
+
### ⚡ 优化改进
|
|
48
76
|
|
|
49
|
-
-
|
|
77
|
+
- 升级核心依赖(axios 1.12 → 1.20、swagger-typescript-api 13.2 → 13.12、tsup 8.5.0 → 8.5.1、@fxri/toolkit 1.1.3 → 1.3.0)
|
|
50
78
|
|
|
51
79
|
## 1.2.0
|
|
52
80
|
|
|
@@ -54,7 +82,7 @@
|
|
|
54
82
|
|
|
55
83
|
### ✨ 新增功能
|
|
56
84
|
|
|
57
|
-
- 接入 @fxri/toolkit
|
|
85
|
+
- 接入 @fxri/toolkit,引入 changesets 变更集发版流程与 .tasks 任务管理(纯工程化,不影响 API)
|
|
58
86
|
|
|
59
87
|
## 1.1.13
|
|
60
88
|
|
|
@@ -68,7 +96,7 @@
|
|
|
68
96
|
|
|
69
97
|
> 2025-12-05 发布
|
|
70
98
|
|
|
71
|
-
### 🐛
|
|
99
|
+
### 🐛 问题修复
|
|
72
100
|
|
|
73
101
|
- 提取参数时将可能存在的引号包含在内
|
|
74
102
|
|
|
@@ -76,7 +104,7 @@
|
|
|
76
104
|
|
|
77
105
|
> 2025-10-15 发布
|
|
78
106
|
|
|
79
|
-
###
|
|
107
|
+
### 🔧 功能调整
|
|
80
108
|
|
|
81
109
|
- 提取响应接口改为 AxiosResponse
|
|
82
110
|
|
|
@@ -84,7 +112,7 @@
|
|
|
84
112
|
|
|
85
113
|
> 2025-10-15 发布
|
|
86
114
|
|
|
87
|
-
###
|
|
115
|
+
### 🔧 功能调整
|
|
88
116
|
|
|
89
117
|
- 提取响应接口改为 AxiosResponseRaw
|
|
90
118
|
|
|
@@ -94,13 +122,13 @@
|
|
|
94
122
|
|
|
95
123
|
### ✨ 新增功能
|
|
96
124
|
|
|
97
|
-
-
|
|
125
|
+
- 替换标签支持 2 个参数(正则表达式 + 替换字符串)
|
|
98
126
|
|
|
99
127
|
## 1.1.8
|
|
100
128
|
|
|
101
129
|
> 2025-10-13 发布
|
|
102
130
|
|
|
103
|
-
### 🐛
|
|
131
|
+
### 🐛 问题修复
|
|
104
132
|
|
|
105
133
|
- 提取响应模板配置错误
|
|
106
134
|
|
|
@@ -108,9 +136,9 @@
|
|
|
108
136
|
|
|
109
137
|
> 2025-10-13 发布
|
|
110
138
|
|
|
111
|
-
###
|
|
139
|
+
### 🔧 功能调整
|
|
112
140
|
|
|
113
|
-
-
|
|
141
|
+
- 调整打包逻辑
|
|
114
142
|
|
|
115
143
|
## 1.1.6
|
|
116
144
|
|
|
@@ -118,14 +146,14 @@
|
|
|
118
146
|
|
|
119
147
|
### ✨ 新增功能
|
|
120
148
|
|
|
121
|
-
-
|
|
122
|
-
-
|
|
149
|
+
- 提取响应,将 AxiosResponse 返回值转移到 raw 字段,根部字段自行定义
|
|
150
|
+
- 提取参数,将 query 参数中的指定对象字段提取为根部字段,支持多选
|
|
123
151
|
|
|
124
152
|
## 1.1.5
|
|
125
153
|
|
|
126
154
|
> 2025-10-12 发布
|
|
127
155
|
|
|
128
|
-
###
|
|
156
|
+
### 🔧 功能调整
|
|
129
157
|
|
|
130
158
|
- debug 模式使用更精简的配置
|
|
131
159
|
|
|
@@ -133,7 +161,7 @@
|
|
|
133
161
|
|
|
134
162
|
> 2025-10-12 发布
|
|
135
163
|
|
|
136
|
-
### 🐛
|
|
164
|
+
### 🐛 问题修复
|
|
137
165
|
|
|
138
166
|
- 默认开启扫描全部配置文件
|
|
139
167
|
|
|
@@ -141,7 +169,7 @@
|
|
|
141
169
|
|
|
142
170
|
> 2025-10-12 发布
|
|
143
171
|
|
|
144
|
-
### 🐛
|
|
172
|
+
### 🐛 问题修复
|
|
145
173
|
|
|
146
174
|
- 读取配置文件前先初始化参数
|
|
147
175
|
|
|
@@ -149,7 +177,7 @@
|
|
|
149
177
|
|
|
150
178
|
> 2025-10-12 发布
|
|
151
179
|
|
|
152
|
-
###
|
|
180
|
+
### 🔧 功能调整
|
|
153
181
|
|
|
154
182
|
- 调整 --remove-dts 参数
|
|
155
183
|
|
|
@@ -169,7 +197,7 @@
|
|
|
169
197
|
|
|
170
198
|
- 引入 tsup 构建,支持 cjs / esm / dts 多格式产物
|
|
171
199
|
|
|
172
|
-
###
|
|
200
|
+
### 🔧 功能调整
|
|
173
201
|
|
|
174
202
|
- 拆分脚本入口,接口生成改用导入执行
|
|
175
203
|
|
|
@@ -179,7 +207,7 @@
|
|
|
179
207
|
|
|
180
208
|
### ✨ 新增功能
|
|
181
209
|
|
|
182
|
-
-
|
|
210
|
+
- 快速模式,直接使用配置文件参数
|
|
183
211
|
- 支持 -rd 移除使用 --js 参数时生成的 d.ts 文件
|
|
184
212
|
|
|
185
213
|
## 1.0.0
|
|
@@ -188,4 +216,4 @@
|
|
|
188
216
|
|
|
189
217
|
### 🚨 重大变更
|
|
190
218
|
|
|
191
|
-
-
|
|
219
|
+
- 首个版本,上传项目并完成基于 swagger-typescript-api 的接口代码生成基础功能
|
package/NOTICE
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
@fxri/swagger2api
|
|
2
|
-
Copyright © 2025-2026 唐启云. All rights reserved.
|
|
3
|
-
|
|
4
|
-
出品方:方弦研究所(唐启云个人项目品牌,非独立法人实体)
|
|
5
|
-
|
|
6
|
-
商标声明:
|
|
7
|
-
"方弦®"为第42类注册商标(注册号89648411),核定服务项目:计算机出租、计算机软件设计、为他人研究和开发新产品、计算机软件维护、把有形的数据或文件转换成电子媒体、为他人创建和维护网站、网络服务器出租、提供互联网搜索引擎、托管计算机站(网站)、云计算。
|
|
8
|
-
本开源许可(MIT License)不授予商标使用权。
|
|
9
|
-
详见 TRADEMARK.md 了解完整商标信息。
|
|
1
|
+
@fxri/swagger2api
|
|
2
|
+
Copyright © 2025-2026 唐启云. All rights reserved.
|
|
3
|
+
|
|
4
|
+
出品方:方弦研究所(唐启云个人项目品牌,非独立法人实体)
|
|
5
|
+
|
|
6
|
+
商标声明:
|
|
7
|
+
"方弦®"为第42类注册商标(注册号89648411),核定服务项目:计算机出租、计算机软件设计、为他人研究和开发新产品、计算机软件维护、把有形的数据或文件转换成电子媒体、为他人创建和维护网站、网络服务器出租、提供互联网搜索引擎、托管计算机站(网站)、云计算。
|
|
8
|
+
本开源许可(MIT License)不授予商标使用权。
|
|
9
|
+
详见 TRADEMARK.md 了解完整商标信息。
|
package/README.md
CHANGED
|
@@ -1,206 +1,92 @@
|
|
|
1
|
-
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="./docs/public/logo.png" width="128" alt="Swagger 转 API">
|
|
3
|
+
</p>
|
|
2
4
|
|
|
3
|
-
|
|
5
|
+
# Swagger 转 API
|
|
4
6
|
|
|
5
|
-
|
|
7
|
+
[](https://www.npmjs.com/package/@fxri/swagger2api)
|
|
8
|
+
[](./docs/getting-started.md#安装)
|
|
9
|
+
[](./LICENSE)
|
|
6
10
|
|
|
7
|
-
|
|
8
|
-
- 📁 **特性区别** - 利用现有参数拼接了新的 operationId 字段,避免了重名接口会出现【_n】后缀的情况。
|
|
9
|
-
- 📝 **拼接规则** - 将接口地址与请求方法拼接作为唯一ID,通过可选参数,将不带【{.+}】参数的【get】改为【query】作区分,然后移除【{.+}】参数,并移除地址的第一个参数。
|
|
10
|
-
- ⚙️ **环境依赖** - 工具需要在 node@20 及以上运行时环境下使用。
|
|
11
|
-
- 🔧 **CLI 工具** - 更多参数可查看 swagger-typescript-api 官方文档。
|
|
11
|
+
> 国内网络建议优先 [Gitee 镜像](https://gitee.com/fxri/swagger2api)(与 GitHub 同源同步);问题反馈走 [GitHub Issues](https://github.com/fxri-net/swagger2api/issues) 或 [Gitee Issues](https://gitee.com/fxri/swagger2api/issues)。
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
基于 [swagger-typescript-api](https://github.com/acacode/swagger-typescript-api) 封装的 CLI 工具:Swagger 文档一键转 TS/JS 格式的 API 文件。
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
后端给到 Swagger 文档,接口代码还要照着手写;接口一多重名 `_n` 后缀满屏;多个项目的接口配置散落各处,更新要挨个跑命令。本工具把这些沉淀为**一行命令**:配置落盘可复用,生成静默无感,调用即取即用。
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
- **多文档配置**:自动扫描项目下全部 `saconfig*.json`,多项目接口集中管理,搭配快速模式一行命令全量更新([怎么玩?](./docs/guide.md#多文档配置))
|
|
18
|
+
- **唯一 operationId**:接口地址 + 请求方法拼接,从源头告别 `_n` 重名后缀([拼接规则](./docs/guide.md#唯一-operationid-拼接规则))
|
|
19
|
+
- **不懂生成的代码也能用**:接口文件含请求方法与类型定义,导入即调;参数全部有默认值,交互引导填写([30 秒上手](./docs/getting-started.md))
|
|
18
20
|
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
1.指定配置文件路径,支持多选,用【,】分隔。
|
|
22
|
-
|
|
23
|
-
2.使用该参数则不会触发扫描全部配置文件功能。
|
|
24
|
-
|
|
25
|
-
### 多文档配置
|
|
26
|
-
|
|
27
|
-
1.默认配置文件为saconfig.json,项目启动后会扫描当前项目下所有符合【./**/saconfig*.json】规则的文件(如【saconfig.json】【saconfig.admin.json】【config/saconfig.json】等),并在扫描到多个文件时提供选择列表,如只有一个文件,则直接进入下一步,该功能可在配置项中关闭。
|
|
28
|
-
|
|
29
|
-
2.此功能扩展使用的话,可以作为一个独立工具使用,同时管理多个项目的接口配置。
|
|
30
|
-
|
|
31
|
-
3.搭配上快速模式和加载全部配置文件参数,可以实现一行命令更新所有项目的接口配置。
|
|
32
|
-
|
|
33
|
-
## 📦 安装
|
|
34
|
-
|
|
35
|
-
pnpm
|
|
21
|
+
## 🚀 30 秒上手
|
|
36
22
|
|
|
37
23
|
```bash
|
|
38
|
-
#
|
|
39
|
-
pnpm
|
|
40
|
-
```
|
|
24
|
+
# 1. 项目目录下临时执行(免安装;已安装则直接 swagger2api)
|
|
25
|
+
pnpm dlx @fxri/swagger2api
|
|
41
26
|
|
|
42
|
-
|
|
43
|
-
#
|
|
44
|
-
pnpm install @fxri/swagger2api
|
|
27
|
+
# 2. 按提示填写 Swagger 文档地址、输出目录、文件名
|
|
28
|
+
# 自动生成接口代码与 saconfig.json 配置文件
|
|
45
29
|
```
|
|
46
30
|
|
|
47
|
-
|
|
31
|
+
```typescript
|
|
32
|
+
import { Api } from "./src/api/index"
|
|
48
33
|
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
34
|
+
/** 请求器 */
|
|
35
|
+
export const request = new Api()
|
|
36
|
+
request.getUsers().then((res) => console.log(res))
|
|
52
37
|
```
|
|
53
38
|
|
|
54
|
-
|
|
55
|
-
# 项目依赖
|
|
56
|
-
yarn add @fxri/swagger2api
|
|
57
|
-
```
|
|
39
|
+
完整步骤见 [新手指南](./docs/getting-started.md)。
|
|
58
40
|
|
|
59
|
-
##
|
|
41
|
+
## ✨ 能力矩阵
|
|
60
42
|
|
|
61
|
-
|
|
43
|
+
| 能力 | 适用场景 | 文档 |
|
|
44
|
+
| --- | --- | --- |
|
|
45
|
+
| 快速生成 | 从 Swagger JSON 生成 TS/JS 接口文件,含请求方法与类型定义 | [新手指南](./docs/getting-started.md) |
|
|
46
|
+
| 多文档配置 | 自动扫描 `./**/saconfig*.json`,多项目接口配置集中管理 | [完整攻略](./docs/guide.md#多文档配置) |
|
|
47
|
+
| 快速模式 | 配置齐全时跳过二次确认,搭配脚本一行命令静默更新 | [完整攻略](./docs/guide.md#快速模式) |
|
|
48
|
+
| 唯一 operationId | 接口地址 + 请求方法拼接唯一 ID,可选 get 转 query 作区分 | [完整攻略](./docs/guide.md#唯一-operationid-拼接规则) |
|
|
49
|
+
| 灵活裁剪 | 移除路径参数 / 前缀索引、替换标签、移除空组件定义 | [CLI 参考](./docs/cli.md#配置选项) |
|
|
50
|
+
| 响应提取 | AxiosResponse 转移到 raw 字段,根部字段自行声明 | [完整攻略](./docs/guide.md#提取响应--extract-response-raw-err) |
|
|
51
|
+
| STA 参数透传 | swagger-typescript-api 原生参数全量可用 | [CLI 参考](./docs/cli.md) |
|
|
62
52
|
|
|
63
|
-
|
|
53
|
+
## 📚 文档
|
|
64
54
|
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
{
|
|
73
|
-
"scripts": {
|
|
74
|
-
"api": "npx @fxri/swagger2api --axios --responses -q -rpi 0 -err"
|
|
75
|
-
}
|
|
76
|
-
}
|
|
77
|
-
```
|
|
78
|
-
|
|
79
|
-
## 🚀 快速开始
|
|
55
|
+
| 文档 | 适合谁 |
|
|
56
|
+
| --- | --- |
|
|
57
|
+
| [新手指南](./docs/getting-started.md) | 第一次接触,想 30 秒跑起来 |
|
|
58
|
+
| [完整攻略](./docs/guide.md) | 日常使用:三种模式、响应提取、配置文件 |
|
|
59
|
+
| [CLI 参考](./docs/cli.md) | 查命令、参数、默认值 |
|
|
60
|
+
| [FAQ](./docs/faq.md) | 遇到问题先来这里找 |
|
|
61
|
+
| [完整文档站](https://fxri-net.github.io/swagger2api/) | 在线阅读体验 |
|
|
80
62
|
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
如果没装过其他名字叫 swagger2api 的工具,那么在 shell 中直接使用就行,如果装过同名工具,则需要带上 @fxri 作用域。
|
|
63
|
+
## 📦 安装
|
|
84
64
|
|
|
85
65
|
```bash
|
|
86
|
-
|
|
66
|
+
pnpm add -D @fxri/swagger2api # 项目依赖(团队推荐,版本随仓库锁定)
|
|
67
|
+
pnpm i -g @fxri/swagger2api # 全局(个人多项目推荐)
|
|
68
|
+
pnpm dlx @fxri/swagger2api # 不安装临时执行
|
|
87
69
|
```
|
|
88
70
|
|
|
89
|
-
|
|
90
|
-
npx @fxri/swagger2api
|
|
91
|
-
```
|
|
71
|
+
npm / yarn 用户、同名工具冲突说明见 [新手指南 · 安装](./docs/getting-started.md#安装)。
|
|
92
72
|
|
|
93
|
-
|
|
73
|
+
## 📁 多文档配置
|
|
94
74
|
|
|
95
|
-
|
|
75
|
+
默认配置文件为 `saconfig.json`;工具会扫描项目下所有 `saconfig*.json`(如 `saconfig.admin.json`、`config/saconfig.json`),多文件时提供选择列表。搭配快速模式与加载全部配置参数,`package.json` 一行脚本即可静默更新所有项目的接口代码:
|
|
96
76
|
|
|
97
77
|
```json
|
|
98
78
|
{
|
|
99
|
-
"
|
|
100
|
-
|
|
101
|
-
"name": "index"
|
|
102
|
-
}
|
|
103
|
-
```
|
|
104
|
-
|
|
105
|
-
### 3. 调用接口
|
|
106
|
-
|
|
107
|
-
直接调用生成的API类方法:
|
|
108
|
-
|
|
109
|
-
```typescript
|
|
110
|
-
import { Api } from "./api"
|
|
111
|
-
/** 请求器 */
|
|
112
|
-
export const request = new Api()
|
|
113
|
-
request.getUsers().then((res) => console.log(res))
|
|
114
|
-
```
|
|
115
|
-
|
|
116
|
-
### 4. 提取响应(如没有使用提取响应参数,则忽略该项)
|
|
117
|
-
|
|
118
|
-
声明自定义的根部字段(以下字段为示例,请根据实际情况自行调整):
|
|
119
|
-
|
|
120
|
-
```typescript
|
|
121
|
-
declare module "." {
|
|
122
|
-
interface AxiosResponse<T extends Record<string, any> = any> {
|
|
123
|
-
/** 状态代码 */
|
|
124
|
-
code: number
|
|
125
|
-
/** 提示信息 */
|
|
126
|
-
message: string
|
|
127
|
-
/** 响应数据 */
|
|
128
|
-
data: T["data"]
|
|
79
|
+
"scripts": {
|
|
80
|
+
"api": "swagger2api --axios --responses -q -rpi 0 -err -ca"
|
|
129
81
|
}
|
|
130
82
|
}
|
|
131
83
|
```
|
|
132
84
|
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
```typescript
|
|
136
|
-
// 响应拦截
|
|
137
|
-
client.instance.interceptors.response.use(
|
|
138
|
-
(response) => ({ code: 0, message: "", data: null, raw: response }),
|
|
139
|
-
(error) => ({ code: -1, message: error.message, data: null, raw: error })
|
|
140
|
-
)
|
|
141
|
-
```
|
|
142
|
-
|
|
143
|
-
每个方法会返回 Promise,可通过 async/await 或 .then() 处理响应。
|
|
144
|
-
|
|
145
|
-
## ⚙️ 配置选项
|
|
146
|
-
|
|
147
|
-
| 选项 | 类型 | 默认值 | 说明 |
|
|
148
|
-
|------|------|--------|------|
|
|
149
|
-
| `url` | string | - | Swagger JSON 文件路径或 URL |
|
|
150
|
-
| `output` | string | `'./src/api'` | 生成代码的输出目录 |
|
|
151
|
-
| `name` | string | `'index'` | 接口文件名称,默认后缀为ts |
|
|
152
|
-
| `--quick,-q` | boolean | `false` | 快速模式,直接使用配置文件参数,不再二次确认参数 |
|
|
153
|
-
| `--config,-c` | string | `'saconfig.json'` | 填写配置文件路径,支持多选,用【,】分隔 |
|
|
154
|
-
| `--config-all,-ca` | boolean | `false` | 加载全部配置文件,不进行选择 |
|
|
155
|
-
| `--config-scan,-cs` | boolean | `true` | 扫描全部配置文件,并提供选择列表 |
|
|
156
|
-
| `--replace-tags,-rt` | string[] | - | 替换标签,2个参数,第1个正则表达式(已包含^$头尾),第2个替换字符串 |
|
|
157
|
-
| `--convert-get,-cg` | boolean | `false` | 转换无{.+}get为query |
|
|
158
|
-
| `--remove-param,-rp` | boolean | `false` | 移除{.+}参数 |
|
|
159
|
-
| `--remove-prefix-index,-rpi` | number | `-1` | 移除前缀索引 |
|
|
160
|
-
| `--remove-dts,-rd` | boolean | `false` | 移除使用--js参数时生成的d.ts文件 |
|
|
161
|
-
| `--remove-empty-components,-rec` | boolean | `true` | 移除空组件定义 |
|
|
162
|
-
| `--extract-request-query,-erq` | string | - | 提取参数,将query参数中的指定对象字段提取为根部字段,支持多选,用【,】分隔,每个接口只提取第一次命中的字段 |
|
|
163
|
-
| `--extract-response-raw,-err` | boolean | `false` | 提取响应,将AxiosResponse返回值转移到raw字段,根部字段自行定义,使用该参数需在响应拦截中重新设计实际的返回值 |
|
|
164
|
-
|
|
165
|
-
扩展:[更多 swagger-typescript-api 配置选项](https://fig.io/manual/swagger-typescript-api)
|
|
166
|
-
|
|
167
|
-
## 🔧 CLI 命令
|
|
168
|
-
|
|
169
|
-
```bash
|
|
170
|
-
# 快速模式,直接使用配置文件参数,不再二次确认参数
|
|
171
|
-
|
|
172
|
-
npx swagger2api [--quick,-q] [--quick,-q <boolean>]
|
|
173
|
-
|
|
174
|
-
npx @fxri/swagger2api [--quick,-q] [--quick,-q <boolean>]
|
|
175
|
-
```
|
|
176
|
-
|
|
177
|
-
```bash
|
|
178
|
-
# 填写配置文件路径,支持多选,用【,】分隔,使用该配置后则不会触发配置扫描功能
|
|
179
|
-
|
|
180
|
-
npx swagger2api [--config,-c <path>]
|
|
181
|
-
|
|
182
|
-
npx @fxri/swagger2api [--config,-c <path>]
|
|
183
|
-
```
|
|
184
|
-
|
|
185
|
-
```bash
|
|
186
|
-
# 移除前缀索引
|
|
187
|
-
|
|
188
|
-
npx swagger2api [--remove-prefix-index,-rpi <number>]
|
|
189
|
-
|
|
190
|
-
npx @fxri/swagger2api [--remove-prefix-index,-rpi <number>]
|
|
191
|
-
```
|
|
192
|
-
|
|
193
|
-
```bash
|
|
194
|
-
# 替换标签,2个参数,第1个正则表达式(已包含^$头尾),第2个替换字符串
|
|
195
|
-
|
|
196
|
-
npx swagger2api [--replace-tags,-rt <regexp> <substr>]
|
|
197
|
-
|
|
198
|
-
npx @fxri/swagger2api [--replace-tags,-rt <regexp> <substr>]
|
|
199
|
-
```
|
|
85
|
+
此功能扩展使用的话,可以作为一个独立工具使用,同时管理多个项目的接口配置。详见 [完整攻略 · 多文档配置](./docs/guide.md#多文档配置)。
|
|
200
86
|
|
|
201
|
-
##
|
|
87
|
+
## ⚙️ 环境要求
|
|
202
88
|
|
|
203
|
-
|
|
89
|
+
- Node.js >= 20
|
|
204
90
|
|
|
205
91
|
## 📄 版权信息
|
|
206
92
|
|
|
@@ -216,4 +102,4 @@ npx @fxri/swagger2api [--replace-tags,-rt <regexp> <substr>]
|
|
|
216
102
|
|
|
217
103
|
商标:"方弦®"为第42类注册商标(注册号89648411),本开源许可不授予商标使用权,详见 [TRADEMARK.md](./TRADEMARK.md)
|
|
218
104
|
|
|
219
|
-
> 方弦研究所为唐启云个人项目品牌与出品方,非独立法人实体;本软件著作权归唐启云所有。
|
|
105
|
+
> 方弦研究所为唐启云个人项目品牌与出品方,非独立法人实体;本软件著作权归唐启云所有。
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fxri/swagger2api",
|
|
3
|
-
"version": "1.2.
|
|
3
|
+
"version": "1.2.8",
|
|
4
4
|
"description": "基于 swagger-typescript-api,将 Swagger 文档自动转为 TypeScript 格式的 API 文件。",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": {
|
|
@@ -42,7 +42,8 @@
|
|
|
42
42
|
"eslint-config-prettier": "^9.1.2",
|
|
43
43
|
"eslint-plugin-vue": "^9.33.0",
|
|
44
44
|
"tsup": "^8.5.1",
|
|
45
|
-
"typescript": "^5.9.3"
|
|
45
|
+
"typescript": "^5.9.3",
|
|
46
|
+
"vitepress": "^1.6.4"
|
|
46
47
|
},
|
|
47
48
|
"engines": {
|
|
48
49
|
"node": ">=20"
|
|
@@ -63,6 +64,10 @@
|
|
|
63
64
|
"build": "cross-env NODE_ENV=production tsup",
|
|
64
65
|
"build:debug": "cross-env NODE_ENV=development tsup --config tsup.dev.config.ts",
|
|
65
66
|
"release": "pnpm build && pnpm publish",
|
|
67
|
+
"sync:changelog-doc": "node scripts/sync-changelog-doc.mjs",
|
|
68
|
+
"docs:dev": "vitepress dev docs",
|
|
69
|
+
"docs:build": "vitepress build docs",
|
|
70
|
+
"docs:preview": "vitepress preview docs",
|
|
66
71
|
"api": "pnpm dev --axios --responses -q -rpi 0 -err",
|
|
67
72
|
"tasks": "toolkit tasks",
|
|
68
73
|
"tasks:archive": "toolkit tasks archive",
|