@fxri/swagger2api 1.2.6 → 1.2.7

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 CHANGED
@@ -1,5 +1,13 @@
1
1
  # @fxri/swagger2api
2
2
 
3
+ ## 1.2.7
4
+
5
+ > 2026-09-06 发布
6
+
7
+ ### 🐛 补丁修复
8
+
9
+ - 新增 VitePress 文档站(GitHub 与 GitLab Pages 双端自动部署),README 重构为橱窗式分层设计并重生成 og-image;全面核对文档与实现一致性,修正无效命令示例(`--quick,-q` 连写、npx 裸名等)与偏差描述,统一 npx 作用域全名口径
10
+
3
11
  ## 1.2.6
4
12
 
5
13
  > 2026-09-06 发布
package/README.md CHANGED
@@ -1,219 +1,105 @@
1
- # @fxri/swagger2api
2
-
3
- 基于 swagger-typescript-api,将 Swagger 文档自动转为 TS/JS 格式的 API 文件。
4
-
5
- ## ✨ 特性
6
-
7
- - 🚀 **快速生成** - 从 Swagger JSON 快速生成 TS/JS 接口代码。
8
- - 📁 **特性区别** - 利用现有参数拼接了新的 operationId 字段,避免了重名接口会出现【_n】后缀的情况。
9
- - 📝 **拼接规则** - 将接口地址与请求方法拼接作为唯一ID,通过可选参数,将不带【{.+}】参数的【get】改为【query】作区分,然后移除【{.+}】参数,并移除地址的第一个参数。
10
- - ⚙️ **环境依赖** - 工具需要在 node@20 及以上运行时环境下使用。
11
- - 🔧 **CLI 工具** - 更多参数可查看 swagger-typescript-api 官方文档。
12
-
13
- ## 💡 功能简介
14
-
15
- ### 快速模式
16
-
17
- 1.直接使用配置文件参数,若配置文件不存在或者参数不全(如第一次运行该工具),则不会进入该模式。
18
-
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
36
-
37
- ```bash
38
- # 全局安装
39
- pnpm install -g @fxri/swagger2api
40
- ```
41
-
42
- ```bash
43
- # 项目依赖
44
- pnpm install @fxri/swagger2api
45
- ```
46
-
47
- yarn
48
-
49
- ```bash
50
- # 全局安装
51
- yarn global add @fxri/swagger2api
52
- ```
53
-
54
- ```bash
55
- # 项目依赖
56
- yarn add @fxri/swagger2api
57
- ```
58
-
59
- ## 📝 PNPM 脚本
60
-
61
- 在 `package.json` 中添加:
62
-
63
- 生成 axios http 客户端,生成有关请求响应的附加信息,移除第一个前缀索引,使用快速模式。
64
-
65
- ```json
66
- {
67
- "scripts": {
68
- "api": "swagger2api --axios --responses -q -rpi 0 -err"
69
- }
70
- }
71
-
72
- {
73
- "scripts": {
74
- "api": "npx @fxri/swagger2api --axios --responses -q -rpi 0 -err"
75
- }
76
- }
77
- ```
78
-
79
- ## 🚀 快速开始
80
-
81
- ### 1. 生成接口代码
82
-
83
- 如果没装过其他名字叫 swagger2api 的工具,那么在 shell 中直接使用就行,如果装过同名工具,则需要带上 @fxri 作用域。
84
-
85
- ```bash
86
- npx swagger2api
87
- ```
88
-
89
- ```bash
90
- npx @fxri/swagger2api
91
- ```
92
-
93
- ### 2. 配置文件说明
94
-
95
- 工具在脚本执行目录生成配置文件,作为生成接口时的默认参数,生成代码结束后,如果参数有改动,则会更新配置文件:
96
-
97
- ```json
98
- {
99
- "url": "https://example.com/v3/api-docs",
100
- "output": "./src/api",
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"]
129
- }
130
- }
131
- ```
132
-
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
- ```
200
-
201
- ## 🤝 贡献
202
-
203
- 欢迎提交 Issue 和 Pull Request!
204
-
205
- ## 📄 版权信息
206
-
207
- 作者:唐启云 <tqy@fxri.net>
208
-
209
- 出品:方弦研究所
210
-
211
- 版权:Copyright © 2025-2026 唐启云. All rights reserved.
212
-
213
- 网站:[方弦研究信息网](https://fxri.net:444/)
214
-
215
- 协议:[MIT License](./LICENSE)
216
-
217
- 商标:"方弦®"为第42类注册商标(注册号89648411),本开源许可不授予商标使用权,详见 [TRADEMARK.md](./TRADEMARK.md)
218
-
219
- > 方弦研究所为唐启云个人项目品牌与出品方,非独立法人实体;本软件著作权归唐启云所有。
1
+ <p align="center">
2
+ <img src="./docs/public/logo.png" width="128" alt="Swagger 转 API">
3
+ </p>
4
+
5
+ # Swagger 转 API
6
+
7
+ [![npm version](https://img.shields.io/npm/v/@fxri/swagger2api)](https://www.npmjs.com/package/@fxri/swagger2api)
8
+ [![Node](https://img.shields.io/badge/node-%E2%89%A520-brightgreen)](./docs/getting-started.md#安装)
9
+ [![License: MIT](https://img.shields.io/badge/license-MIT-blue)](./LICENSE)
10
+
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
+
13
+ 基于 [swagger-typescript-api](https://github.com/acacode/swagger-typescript-api) 封装的 CLI 工具:Swagger 文档一键转 TS/JS 格式的 API 文件。
14
+
15
+ 后端给到 Swagger 文档,接口代码还要照着手写;接口一多重名 `_n` 后缀满屏;多个项目的接口配置散落各处,更新要挨个跑命令。本工具把这些沉淀为**一行命令**:配置落盘可复用,生成静默无感,调用即取即用。
16
+
17
+ - **多文档配置**:自动扫描项目下全部 `saconfig*.json`,多项目接口集中管理,搭配快速模式一行命令全量更新([怎么玩?](./docs/guide.md#多文档配置))
18
+ - **唯一 operationId**:接口地址 + 请求方法拼接,从源头告别 `_n` 重名后缀([拼接规则](./docs/guide.md#唯一-operationid-拼接规则))
19
+ - **不懂生成的代码也能用**:接口文件含请求方法与类型定义,导入即调;参数全部有默认值,交互引导填写([30 秒上手](./docs/getting-started.md))
20
+
21
+ ## 🚀 30 秒上手
22
+
23
+ ```bash
24
+ # 1. 项目目录下临时执行(免安装;已安装则直接 swagger2api)
25
+ pnpm dlx @fxri/swagger2api
26
+
27
+ # 2. 按提示填写 Swagger 文档地址、输出目录、文件名
28
+ # 自动生成接口代码与 saconfig.json 配置文件
29
+ ```
30
+
31
+ ```typescript
32
+ import { Api } from "./src/api/index"
33
+
34
+ /** 请求器 */
35
+ export const request = new Api()
36
+ request.getUsers().then((res) => console.log(res))
37
+ ```
38
+
39
+ 完整步骤见 [新手指南](./docs/getting-started.md)。
40
+
41
+ ## ✨ 能力矩阵
42
+
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) |
52
+
53
+ ## 📚 文档
54
+
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/) | 在线阅读体验 |
62
+
63
+ ## 📦 安装
64
+
65
+ ```bash
66
+ pnpm add -D @fxri/swagger2api # 项目依赖(团队推荐,版本随仓库锁定)
67
+ pnpm i -g @fxri/swagger2api # 全局(个人多项目推荐)
68
+ pnpm dlx @fxri/swagger2api # 不安装临时执行
69
+ ```
70
+
71
+ npm / yarn 用户、同名工具冲突说明见 [新手指南 · 安装](./docs/getting-started.md#安装)。
72
+
73
+ ## 📁 多文档配置
74
+
75
+ 默认配置文件为 `saconfig.json`;工具会扫描项目下所有 `saconfig*.json`(如 `saconfig.admin.json`、`config/saconfig.json`),多文件时提供选择列表。搭配快速模式与加载全部配置参数,`package.json` 一行脚本即可静默更新所有项目的接口代码:
76
+
77
+ ```json
78
+ {
79
+ "scripts": {
80
+ "api": "swagger2api --axios --responses -q -rpi 0 -err -ca"
81
+ }
82
+ }
83
+ ```
84
+
85
+ 此功能扩展使用的话,可以作为一个独立工具使用,同时管理多个项目的接口配置。详见 [完整攻略 · 多文档配置](./docs/guide.md#多文档配置)。
86
+
87
+ ## ⚙️ 环境要求
88
+
89
+ - Node.js >= 20
90
+
91
+ ## 📄 版权信息
92
+
93
+ 作者:唐启云 <tqy@fxri.net>
94
+
95
+ 出品:方弦研究所
96
+
97
+ 版权:Copyright © 2025-2026 唐启云. All rights reserved.
98
+
99
+ 网站:[方弦研究信息网](https://fxri.net:444/)
100
+
101
+ 协议:[MIT License](./LICENSE)
102
+
103
+ 商标:"方弦®"为第42类注册商标(注册号89648411),本开源许可不授予商标使用权,详见 [TRADEMARK.md](./TRADEMARK.md)
104
+
105
+ > 方弦研究所为唐启云个人项目品牌与出品方,非独立法人实体;本软件著作权归唐启云所有。
package/dist/cli.js CHANGED
File without changes
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fxri/swagger2api",
3
- "version": "1.2.6",
3
+ "version": "1.2.7",
4
4
  "description": "基于 swagger-typescript-api,将 Swagger 文档自动转为 TypeScript 格式的 API 文件。",
5
5
  "license": "MIT",
6
6
  "author": {
@@ -20,6 +20,21 @@
20
20
  "NOTICE",
21
21
  "package.json"
22
22
  ],
23
+ "scripts": {
24
+ "dev": "pnpm build:debug && node ./dist/cli.js",
25
+ "build": "cross-env NODE_ENV=production tsup",
26
+ "build:debug": "cross-env NODE_ENV=development tsup --config tsup.dev.config.ts",
27
+ "release": "pnpm build && pnpm publish",
28
+ "sync:changelog-doc": "node scripts/sync-changelog-doc.mjs",
29
+ "docs:dev": "vitepress dev docs",
30
+ "docs:build": "vitepress build docs",
31
+ "docs:preview": "vitepress preview docs",
32
+ "api": "pnpm dev --axios --responses -q -rpi 0 -err",
33
+ "tasks": "toolkit tasks",
34
+ "tasks:archive": "toolkit tasks archive",
35
+ "changeset": "toolkit changelog",
36
+ "version": "toolkit changelog version"
37
+ },
23
38
  "keywords": [
24
39
  "swagger",
25
40
  "typescript",
@@ -42,8 +57,15 @@
42
57
  "eslint-config-prettier": "^9.1.2",
43
58
  "eslint-plugin-vue": "^9.33.0",
44
59
  "tsup": "^8.5.1",
45
- "typescript": "^5.9.3"
60
+ "typescript": "^5.9.3",
61
+ "vitepress": "^1.6.4"
62
+ },
63
+ "pnpm": {
64
+ "onlyBuiltDependencies": [
65
+ "esbuild"
66
+ ]
46
67
  },
68
+ "packageManager": "pnpm@10.34.4",
47
69
  "engines": {
48
70
  "node": ">=20"
49
71
  },
@@ -57,16 +79,5 @@
57
79
  },
58
80
  "bugs": {
59
81
  "url": "https://github.com/fxri-net/swagger2api/issues"
60
- },
61
- "scripts": {
62
- "dev": "pnpm build:debug && node ./dist/cli.js",
63
- "build": "cross-env NODE_ENV=production tsup",
64
- "build:debug": "cross-env NODE_ENV=development tsup --config tsup.dev.config.ts",
65
- "release": "pnpm build && pnpm publish",
66
- "api": "pnpm dev --axios --responses -q -rpi 0 -err",
67
- "tasks": "toolkit tasks",
68
- "tasks:archive": "toolkit tasks archive",
69
- "changeset": "toolkit changelog",
70
- "version": "toolkit changelog version"
71
82
  }
72
- }
83
+ }