swgto-ts 3.1.0 → 3.2.0
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 +218 -218
- package/dist/{chunk-PAFR76SO.js → chunk-4K4VW2PJ.js} +10 -28
- package/dist/{chunk-HBBM5HFP.js → chunk-EAGONRXV.js} +45 -1
- package/dist/cli.js +2 -2
- package/dist/{genApiDocsHtml-V7PDR4PW.js → genApiDocsHtml-ZM2XY5P2.js} +1 -1
- package/dist/{genApiDocsMd-WVDJY3ST.js → genApiDocsMd-UOK4S7BK.js} +1 -1
- package/dist/index.js +2 -2
- package/package.json +43 -42
package/README.md
CHANGED
|
@@ -1,218 +1,218 @@
|
|
|
1
|
-
# swgto
|
|
2
|
-
|
|
3
|
-
`swgto` 是一个把 `OpenAPI 3.x` 文档转换成项目内请求函数的 Node.js 库和 CLI。
|
|
4
|
-
|
|
5
|
-
安装后会注册一个 `swgto` 命令。执行时它会在当前目录查找 `.swaggerts.config.ts` 或 `.swaggerts.config.js`,然后生成:
|
|
6
|
-
|
|
7
|
-
- 按路径前缀分组的请求文件
|
|
8
|
-
- 按文档模块输出请求文件。单文档默认输出到 `services/`,多文档时多个模块目录平级
|
|
9
|
-
- `outputDir/index.ts` 或 `outputDir/index.js`
|
|
10
|
-
- 类型文件 `outputDir/types.ts` 或带 JSDoc 的 `outputDir/types.js`
|
|
11
|
-
|
|
12
|
-
## 安装
|
|
13
|
-
|
|
14
|
-
```bash
|
|
15
|
-
npm install swgto-ts
|
|
16
|
-
```
|
|
17
|
-
|
|
18
|
-
## 配置
|
|
19
|
-
|
|
20
|
-
在项目根目录创建 `.swaggerts.config.ts`:
|
|
21
|
-
|
|
22
|
-
```ts
|
|
23
|
-
import type { SwaggerTsConfig } from 'swgto-ts'
|
|
24
|
-
|
|
25
|
-
const config: SwaggerTsConfig = {
|
|
26
|
-
docUrls: 'https://example.com/openapi.json',
|
|
27
|
-
httpClientPath: '@/utils/request',
|
|
28
|
-
outputDir: 'src/api',
|
|
29
|
-
outputType: 'ts',
|
|
30
|
-
typeName: 'types',
|
|
31
|
-
cleanOutput: true,
|
|
32
|
-
renameMethod: (apiPath, method) => `${method}_${apiPath.replace(/[\\/{}]/g, '_')}`,
|
|
33
|
-
resolveRequestPath: (apiPath, method) => `/proxy${apiPath}`,
|
|
34
|
-
}
|
|
35
|
-
|
|
36
|
-
export default config
|
|
37
|
-
```
|
|
38
|
-
|
|
39
|
-
多文档模式下需要提供 `moduleName`:
|
|
40
|
-
|
|
41
|
-
```ts
|
|
42
|
-
export default {
|
|
43
|
-
docUrls: ['https://example.com/user-openapi.json', 'https://example.com/order-openapi.json'],
|
|
44
|
-
httpClientPath: '@/utils/request',
|
|
45
|
-
outputDir: 'src/api',
|
|
46
|
-
moduleName: (docUrl) => (docUrl.includes('user') ? 'user' : 'order'),
|
|
47
|
-
}
|
|
48
|
-
```
|
|
49
|
-
|
|
50
|
-
## 使用
|
|
51
|
-
|
|
52
|
-
```bash
|
|
53
|
-
swgto
|
|
54
|
-
```
|
|
55
|
-
|
|
56
|
-
## 输出示例
|
|
57
|
-
|
|
58
|
-
```text
|
|
59
|
-
src/api/
|
|
60
|
-
index.ts
|
|
61
|
-
types.ts
|
|
62
|
-
services/
|
|
63
|
-
get_user_list.ts
|
|
64
|
-
post_user_create.ts
|
|
65
|
-
```
|
|
66
|
-
|
|
67
|
-
## 配置项
|
|
68
|
-
|
|
69
|
-
```ts
|
|
70
|
-
export interface SwaggerTsConfig {
|
|
71
|
-
docUrls: string | string[]
|
|
72
|
-
httpClientPath: string
|
|
73
|
-
renameMethod?: (path: string, method: string) => string
|
|
74
|
-
resolveRequestPath?: (path: string, method: string, docUrl: string) => string
|
|
75
|
-
ignoreUrl?: (path: string, method: string, docUrl: string) => boolean
|
|
76
|
-
outputDir?: string
|
|
77
|
-
moduleName?: (docUrl: string) => string
|
|
78
|
-
outputType?: 'ts' | 'js'
|
|
79
|
-
typeName?: string
|
|
80
|
-
cleanOutput?: boolean
|
|
81
|
-
fileNaming?: 'module' | 'path'
|
|
82
|
-
flattenQueryParam?: boolean
|
|
83
|
-
mergeParams?: boolean
|
|
84
|
-
flattenOnGet?: boolean
|
|
85
|
-
apiDocs?: ApiDocsConfig
|
|
86
|
-
}
|
|
87
|
-
```
|
|
88
|
-
|
|
89
|
-
### 字段说明
|
|
90
|
-
|
|
91
|
-
| 字段 | 类型 | 默认值 | 说明 |
|
|
92
|
-
| -------------------- | ----------------------------------- | ------------ | -------------------------------------------------------------------------------------------------------------------------------------- |
|
|
93
|
-
| `docUrls` | `string \| string[]` | (必填) | OpenAPI 3.x 文档的 URL,支持单文档字符串或多文档数组 |
|
|
94
|
-
| `httpClientPath` | `string` | (必填) | 项目内 HTTP 请求工具的引入路径,生成的文件会从中 `import request` |
|
|
95
|
-
| `outputDir` | `string` | `'src/api'` | 代码输出目录,相对项目根目录 |
|
|
96
|
-
| `outputType` | `'ts' \| 'js'` | `'ts'` | 输出文件类型,`'ts'` 生成 `.ts` 文件,`'js'` 生成 `.js` 文件(带 JSDoc 类型注释) |
|
|
97
|
-
| `typeName` | `string` | `'types'` | 类型文件名(不含后缀),如 `'types'` 生成 `types.ts` 或 `types.js` |
|
|
98
|
-
| `fileNaming` | `'module' \| 'path'` | `'path'` | 文件组织方式:`'path'` 按接口路径每个文件一个函数;`'module'` 按控制器合并到同一个文件 |
|
|
99
|
-
| `moduleName` | `(docUrl) => string` | `'services'` | 多文档时,为每个文档指定模块目录名。多文档模式下**必填** |
|
|
100
|
-
| `renameMethod` | `(path, method) => string` | 见说明 | 自定义函数名生成规则。默认根据路径和方法名自动生成(如 `get_user_list`) |
|
|
101
|
-
| `resolveRequestPath` | `(path, method, docUrl) => string` | 原路径 | 自定义请求路径转换规则,可用于添加统一前缀等,如 `(path) => \`/proxy\${path}\`` |
|
|
102
|
-
| `ignoreUrl` | `(path, method, docUrl) => boolean` | 不过滤 | 过滤不需要生成代码的接口,返回 `true` 跳过当前接口 |
|
|
103
|
-
| `cleanOutput` | `boolean` | `false` | 生成前是否清空输出目录 |
|
|
104
|
-
| `flattenQueryParam` | `boolean` | `false` | 当 query 参数只有一个且为 `$ref` 引用类型时,直接用引用类型代替 `{ query: RefType }` |
|
|
105
|
-
| `mergeParams` | `boolean` | `false` | 合并参数层级:`true` 时展平 `path/query/body` 嵌套,直接使用 `params: { field1, field2 }` 代替 `params: { path: {...}, query: {...} }` |
|
|
106
|
-
| `flattenOnGet` | `boolean` | `false` | GET 请求专用展平:将所有 body/query/path 中的 `$ref` 参数展开为顶层交叉类型,彻底消除嵌套。详见 [GET 参数展平](#get-参数展平) |
|
|
107
|
-
| `apiDocs` | `ApiDocsConfig` | 见说明 | 自动生成 API 文档(HTML/Markdown),详细配置见 [API 文档生成](#api-文档生成) |
|
|
108
|
-
|
|
109
|
-
### 函数名生成规则
|
|
110
|
-
|
|
111
|
-
默认函数名格式为 `{method}_{path_segments}`,如:
|
|
112
|
-
|
|
113
|
-
- `GET /user/list` → `get_user_list`
|
|
114
|
-
- `POST /user/create` → `post_user_create`
|
|
115
|
-
|
|
116
|
-
可通过 `renameMethod` 自定义:
|
|
117
|
-
|
|
118
|
-
```ts
|
|
119
|
-
renameMethod: (path, method) => `${method}_${path.replace(/[\\/{}]/g, '_')}`,
|
|
120
|
-
```
|
|
121
|
-
|
|
122
|
-
### 文件组织方式
|
|
123
|
-
|
|
124
|
-
**`fileNaming: 'path'`(默认)**— 每个接口生成独立文件:
|
|
125
|
-
|
|
126
|
-
```
|
|
127
|
-
src/api/moduleA/
|
|
128
|
-
get_user_list.ts
|
|
129
|
-
post_user_create.ts
|
|
130
|
-
get_user_detail.ts
|
|
131
|
-
```
|
|
132
|
-
|
|
133
|
-
**`fileNaming: 'module'`**— 按控制器合并文件(自动识别 RESTful 资源路径分组):
|
|
134
|
-
|
|
135
|
-
```
|
|
136
|
-
src/api/moduleA/
|
|
137
|
-
user.ts // 包含 get_user_list, post_user_create, get_user_detail
|
|
138
|
-
order.ts // 包含 get_order_list, post_order_create
|
|
139
|
-
```
|
|
140
|
-
|
|
141
|
-
### 参数合并模式
|
|
142
|
-
|
|
143
|
-
`mergeParams: true` 时展平参数层级,适用于不想嵌套 `path/query/body` 的场景:
|
|
144
|
-
|
|
145
|
-
```ts
|
|
146
|
-
// mergeParams: false(默认),参数按来源嵌套
|
|
147
|
-
getUser({ path: { id: '1' }, query: { name: 'foo' } })
|
|
148
|
-
|
|
149
|
-
// mergeParams: true,参数展平
|
|
150
|
-
getUser({ id: '1', name: 'foo' })
|
|
151
|
-
```
|
|
152
|
-
|
|
153
|
-
### GET 参数展平
|
|
154
|
-
|
|
155
|
-
`flattenOnGet: true` 专门解决 GET 请求中 body 和 query 参数嵌套的问题。当 GET 请求同时包含 body 参数(如 `userDTO`)和 query 参数(如 `pageQuery`)时,会将所有 `$ref` 类型的参数展开为顶层交叉类型,实现 `{...userDTO, ...pageQuery}` 的效果。
|
|
156
|
-
|
|
157
|
-
**背景**:部分后端定义 GET 请求时,参数在 body 和 query 中分散定义,但实际入参是合并平铺的。仅靠 `mergeParams` 会保留 body 内部的属性名作为嵌套字段。
|
|
158
|
-
|
|
159
|
-
**示例**:一个 GET 请求的 body 中有 `adminUserVO: AdminUserVO`,query 中有 `pageRequest: SessionPageRequestDTO`
|
|
160
|
-
|
|
161
|
-
```ts
|
|
162
|
-
// flattenOnGet: false(默认),body 属性名保留为嵌套字段
|
|
163
|
-
get_ai_sessions({ adminUserVO: {...}, pageRequest: {...} })
|
|
164
|
-
// 类型:{ adminUserVO: AdminUserVO; pageRequest: SessionPageRequestDTO; }
|
|
165
|
-
|
|
166
|
-
// flattenOnGet: true,$ref 参数全部展开到顶层
|
|
167
|
-
get_ai_sessions({ ...adminUserVOFields, ...pageRequestFields })
|
|
168
|
-
// 类型:AdminUserVO & SessionPageRequestDTO
|
|
169
|
-
```
|
|
170
|
-
|
|
171
|
-
> **注意**:`flattenOnGet` 仅对 GET 请求生效,且通常与 `mergeParams` 和 `flattenQueryParam` 一起使用效果最佳。该选项会同时影响生成的类型签名和函数体实现。
|
|
172
|
-
|
|
173
|
-
### API 文档生成
|
|
174
|
-
|
|
175
|
-
配置 `apiDocs` 可在生成代码的同时,自动输出一份人类可读的 API 文档:
|
|
176
|
-
|
|
177
|
-
```ts
|
|
178
|
-
export default {
|
|
179
|
-
// ... 其他配置
|
|
180
|
-
apiDocs: {
|
|
181
|
-
enable: true,
|
|
182
|
-
format: 'html', // 'html' 或 'markdown'
|
|
183
|
-
output: 'api-docs.html', // 输出文件名
|
|
184
|
-
title: '我的 API 文档', // 文档标题,默认取 OpenAPI info.title
|
|
185
|
-
companyName: 'XX 公司', // 封面公司名称(仅 HTML)
|
|
186
|
-
template: './my-template.html', // 自定义 HTML 模板路径(仅 HTML)
|
|
187
|
-
theme: './my-theme.css', // 自定义样式文件路径(仅 HTML)
|
|
188
|
-
},
|
|
189
|
-
}
|
|
190
|
-
```
|
|
191
|
-
|
|
192
|
-
| 配置项 | 类型 | 默认值 | 说明 |
|
|
193
|
-
| ------------- | --------------------------- | ----------------------- | -------------------------------------------------------------- |
|
|
194
|
-
| `enable` | `boolean` | `false` | 是否开启文档生成 |
|
|
195
|
-
| `format` | `'html' \| 'markdown'` | `'html'` | 输出格式:HTML 适合浏览器打印为 PDF,Markdown 适合仓库内查看 |
|
|
196
|
-
| `output` | `string` | `'api-docs.html'` | 输出文件名,相对 `outputDir` |
|
|
197
|
-
| `title` | `string` | OpenAPI `info.title` | 文档标题 |
|
|
198
|
-
| `companyName` | `string` | 无 | 封面上的公司名称(仅 HTML) |
|
|
199
|
-
| `template` | `string` | 内置模板 | 自定义 HTML 模板路径(仅 HTML)。优先级:`template` 配置 > 项目根目录 `.swagger.docs.html` > 内置默认模板 |
|
|
200
|
-
| `theme` | `string` | 无 | 自定义 CSS 文件路径,覆盖文档样式(仅 HTML) |
|
|
201
|
-
|
|
202
|
-
#### HTML 文档
|
|
203
|
-
|
|
204
|
-
输出为带书本风格的 HTML 页面,包含:
|
|
205
|
-
- **封面页**:A4 整页,显示公司名称(如配置)、API 名称和版本号
|
|
206
|
-
- **目录**:方法 + 路径 | 点线 | 摘要,点击跳转到对应接口
|
|
207
|
-
- **接口卡片**:包含路径参数、查询参数、请求体、响应体的字段表格(名称 / 类型 / 必填 / 描述)
|
|
208
|
-
|
|
209
|
-
可通过项目根目录的 `.swagger.docs.html` 文件自定义文档样式。如果设置了 `apiDocs.template`,则优先使用该路径的模板文件。
|
|
210
|
-
|
|
211
|
-
#### Markdown 文档
|
|
212
|
-
|
|
213
|
-
输出为 `.md` 文件,包含:
|
|
214
|
-
- 封面区域:公司名称(如配置)、API 名称和版本号
|
|
215
|
-
- 目录(Table of Contents):所有接口的锚点链接列表
|
|
216
|
-
- 每个接口的详细说明:HTTP 方法 + 路径、描述、参数表格和响应表格
|
|
217
|
-
|
|
218
|
-
适合直接在代码仓库中查看或用于 GitBook、VuePress 等文档工具。```
|
|
1
|
+
# swgto
|
|
2
|
+
|
|
3
|
+
`swgto` 是一个把 `OpenAPI 3.x` 文档转换成项目内请求函数的 Node.js 库和 CLI。
|
|
4
|
+
|
|
5
|
+
安装后会注册一个 `swgto` 命令。执行时它会在当前目录查找 `.swaggerts.config.ts` 或 `.swaggerts.config.js`,然后生成:
|
|
6
|
+
|
|
7
|
+
- 按路径前缀分组的请求文件
|
|
8
|
+
- 按文档模块输出请求文件。单文档默认输出到 `services/`,多文档时多个模块目录平级
|
|
9
|
+
- `outputDir/index.ts` 或 `outputDir/index.js`
|
|
10
|
+
- 类型文件 `outputDir/types.ts` 或带 JSDoc 的 `outputDir/types.js`
|
|
11
|
+
|
|
12
|
+
## 安装
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
npm install swgto-ts
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## 配置
|
|
19
|
+
|
|
20
|
+
在项目根目录创建 `.swaggerts.config.ts`:
|
|
21
|
+
|
|
22
|
+
```ts
|
|
23
|
+
import type { SwaggerTsConfig } from 'swgto-ts'
|
|
24
|
+
|
|
25
|
+
const config: SwaggerTsConfig = {
|
|
26
|
+
docUrls: 'https://example.com/openapi.json',
|
|
27
|
+
httpClientPath: '@/utils/request',
|
|
28
|
+
outputDir: 'src/api',
|
|
29
|
+
outputType: 'ts',
|
|
30
|
+
typeName: 'types',
|
|
31
|
+
cleanOutput: true,
|
|
32
|
+
renameMethod: (apiPath, method) => `${method}_${apiPath.replace(/[\\/{}]/g, '_')}`,
|
|
33
|
+
resolveRequestPath: (apiPath, method) => `/proxy${apiPath}`,
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
export default config
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
多文档模式下需要提供 `moduleName`:
|
|
40
|
+
|
|
41
|
+
```ts
|
|
42
|
+
export default {
|
|
43
|
+
docUrls: ['https://example.com/user-openapi.json', 'https://example.com/order-openapi.json'],
|
|
44
|
+
httpClientPath: '@/utils/request',
|
|
45
|
+
outputDir: 'src/api',
|
|
46
|
+
moduleName: (docUrl) => (docUrl.includes('user') ? 'user' : 'order'),
|
|
47
|
+
}
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## 使用
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
swgto
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
## 输出示例
|
|
57
|
+
|
|
58
|
+
```text
|
|
59
|
+
src/api/
|
|
60
|
+
index.ts
|
|
61
|
+
types.ts
|
|
62
|
+
services/
|
|
63
|
+
get_user_list.ts
|
|
64
|
+
post_user_create.ts
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## 配置项
|
|
68
|
+
|
|
69
|
+
```ts
|
|
70
|
+
export interface SwaggerTsConfig {
|
|
71
|
+
docUrls: string | string[]
|
|
72
|
+
httpClientPath: string
|
|
73
|
+
renameMethod?: (path: string, method: string) => string
|
|
74
|
+
resolveRequestPath?: (path: string, method: string, docUrl: string) => string
|
|
75
|
+
ignoreUrl?: (path: string, method: string, docUrl: string) => boolean
|
|
76
|
+
outputDir?: string
|
|
77
|
+
moduleName?: (docUrl: string) => string
|
|
78
|
+
outputType?: 'ts' | 'js'
|
|
79
|
+
typeName?: string
|
|
80
|
+
cleanOutput?: boolean
|
|
81
|
+
fileNaming?: 'module' | 'path'
|
|
82
|
+
flattenQueryParam?: boolean
|
|
83
|
+
mergeParams?: boolean
|
|
84
|
+
flattenOnGet?: boolean
|
|
85
|
+
apiDocs?: ApiDocsConfig
|
|
86
|
+
}
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
### 字段说明
|
|
90
|
+
|
|
91
|
+
| 字段 | 类型 | 默认值 | 说明 |
|
|
92
|
+
| -------------------- | ----------------------------------- | ------------ | -------------------------------------------------------------------------------------------------------------------------------------- |
|
|
93
|
+
| `docUrls` | `string \| string[]` | (必填) | OpenAPI 3.x 文档的 URL,支持单文档字符串或多文档数组 |
|
|
94
|
+
| `httpClientPath` | `string` | (必填) | 项目内 HTTP 请求工具的引入路径,生成的文件会从中 `import request` |
|
|
95
|
+
| `outputDir` | `string` | `'src/api'` | 代码输出目录,相对项目根目录 |
|
|
96
|
+
| `outputType` | `'ts' \| 'js'` | `'ts'` | 输出文件类型,`'ts'` 生成 `.ts` 文件,`'js'` 生成 `.js` 文件(带 JSDoc 类型注释) |
|
|
97
|
+
| `typeName` | `string` | `'types'` | 类型文件名(不含后缀),如 `'types'` 生成 `types.ts` 或 `types.js` |
|
|
98
|
+
| `fileNaming` | `'module' \| 'path'` | `'path'` | 文件组织方式:`'path'` 按接口路径每个文件一个函数;`'module'` 按控制器合并到同一个文件 |
|
|
99
|
+
| `moduleName` | `(docUrl) => string` | `'services'` | 多文档时,为每个文档指定模块目录名。多文档模式下**必填** |
|
|
100
|
+
| `renameMethod` | `(path, method) => string` | 见说明 | 自定义函数名生成规则。默认根据路径和方法名自动生成(如 `get_user_list`) |
|
|
101
|
+
| `resolveRequestPath` | `(path, method, docUrl) => string` | 原路径 | 自定义请求路径转换规则,可用于添加统一前缀等,如 `(path) => \`/proxy\${path}\`` |
|
|
102
|
+
| `ignoreUrl` | `(path, method, docUrl) => boolean` | 不过滤 | 过滤不需要生成代码的接口,返回 `true` 跳过当前接口 |
|
|
103
|
+
| `cleanOutput` | `boolean` | `false` | 生成前是否清空输出目录 |
|
|
104
|
+
| `flattenQueryParam` | `boolean` | `false` | 当 query 参数只有一个且为 `$ref` 引用类型时,直接用引用类型代替 `{ query: RefType }` |
|
|
105
|
+
| `mergeParams` | `boolean` | `false` | 合并参数层级:`true` 时展平 `path/query/body` 嵌套,直接使用 `params: { field1, field2 }` 代替 `params: { path: {...}, query: {...} }` |
|
|
106
|
+
| `flattenOnGet` | `boolean` | `false` | GET 请求专用展平:将所有 body/query/path 中的 `$ref` 参数展开为顶层交叉类型,彻底消除嵌套。详见 [GET 参数展平](#get-参数展平) |
|
|
107
|
+
| `apiDocs` | `ApiDocsConfig` | 见说明 | 自动生成 API 文档(HTML/Markdown),详细配置见 [API 文档生成](#api-文档生成) |
|
|
108
|
+
|
|
109
|
+
### 函数名生成规则
|
|
110
|
+
|
|
111
|
+
默认函数名格式为 `{method}_{path_segments}`,如:
|
|
112
|
+
|
|
113
|
+
- `GET /user/list` → `get_user_list`
|
|
114
|
+
- `POST /user/create` → `post_user_create`
|
|
115
|
+
|
|
116
|
+
可通过 `renameMethod` 自定义:
|
|
117
|
+
|
|
118
|
+
```ts
|
|
119
|
+
renameMethod: (path, method) => `${method}_${path.replace(/[\\/{}]/g, '_')}`,
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
### 文件组织方式
|
|
123
|
+
|
|
124
|
+
**`fileNaming: 'path'`(默认)**— 每个接口生成独立文件:
|
|
125
|
+
|
|
126
|
+
```
|
|
127
|
+
src/api/moduleA/
|
|
128
|
+
get_user_list.ts
|
|
129
|
+
post_user_create.ts
|
|
130
|
+
get_user_detail.ts
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
**`fileNaming: 'module'`**— 按控制器合并文件(自动识别 RESTful 资源路径分组):
|
|
134
|
+
|
|
135
|
+
```
|
|
136
|
+
src/api/moduleA/
|
|
137
|
+
user.ts // 包含 get_user_list, post_user_create, get_user_detail
|
|
138
|
+
order.ts // 包含 get_order_list, post_order_create
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
### 参数合并模式
|
|
142
|
+
|
|
143
|
+
`mergeParams: true` 时展平参数层级,适用于不想嵌套 `path/query/body` 的场景:
|
|
144
|
+
|
|
145
|
+
```ts
|
|
146
|
+
// mergeParams: false(默认),参数按来源嵌套
|
|
147
|
+
getUser({ path: { id: '1' }, query: { name: 'foo' } })
|
|
148
|
+
|
|
149
|
+
// mergeParams: true,参数展平
|
|
150
|
+
getUser({ id: '1', name: 'foo' })
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
### GET 参数展平
|
|
154
|
+
|
|
155
|
+
`flattenOnGet: true` 专门解决 GET 请求中 body 和 query 参数嵌套的问题。当 GET 请求同时包含 body 参数(如 `userDTO`)和 query 参数(如 `pageQuery`)时,会将所有 `$ref` 类型的参数展开为顶层交叉类型,实现 `{...userDTO, ...pageQuery}` 的效果。
|
|
156
|
+
|
|
157
|
+
**背景**:部分后端定义 GET 请求时,参数在 body 和 query 中分散定义,但实际入参是合并平铺的。仅靠 `mergeParams` 会保留 body 内部的属性名作为嵌套字段。
|
|
158
|
+
|
|
159
|
+
**示例**:一个 GET 请求的 body 中有 `adminUserVO: AdminUserVO`,query 中有 `pageRequest: SessionPageRequestDTO`
|
|
160
|
+
|
|
161
|
+
```ts
|
|
162
|
+
// flattenOnGet: false(默认),body 属性名保留为嵌套字段
|
|
163
|
+
get_ai_sessions({ adminUserVO: {...}, pageRequest: {...} })
|
|
164
|
+
// 类型:{ adminUserVO: AdminUserVO; pageRequest: SessionPageRequestDTO; }
|
|
165
|
+
|
|
166
|
+
// flattenOnGet: true,$ref 参数全部展开到顶层
|
|
167
|
+
get_ai_sessions({ ...adminUserVOFields, ...pageRequestFields })
|
|
168
|
+
// 类型:AdminUserVO & SessionPageRequestDTO
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
> **注意**:`flattenOnGet` 仅对 GET 请求生效,且通常与 `mergeParams` 和 `flattenQueryParam` 一起使用效果最佳。该选项会同时影响生成的类型签名和函数体实现。
|
|
172
|
+
|
|
173
|
+
### API 文档生成
|
|
174
|
+
|
|
175
|
+
配置 `apiDocs` 可在生成代码的同时,自动输出一份人类可读的 API 文档:
|
|
176
|
+
|
|
177
|
+
```ts
|
|
178
|
+
export default {
|
|
179
|
+
// ... 其他配置
|
|
180
|
+
apiDocs: {
|
|
181
|
+
enable: true,
|
|
182
|
+
format: 'html', // 'html' 或 'markdown'
|
|
183
|
+
output: 'api-docs.html', // 输出文件名
|
|
184
|
+
title: '我的 API 文档', // 文档标题,默认取 OpenAPI info.title
|
|
185
|
+
companyName: 'XX 公司', // 封面公司名称(仅 HTML)
|
|
186
|
+
template: './my-template.html', // 自定义 HTML 模板路径(仅 HTML)
|
|
187
|
+
theme: './my-theme.css', // 自定义样式文件路径(仅 HTML)
|
|
188
|
+
},
|
|
189
|
+
}
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
| 配置项 | 类型 | 默认值 | 说明 |
|
|
193
|
+
| ------------- | --------------------------- | ----------------------- | -------------------------------------------------------------- |
|
|
194
|
+
| `enable` | `boolean` | `false` | 是否开启文档生成 |
|
|
195
|
+
| `format` | `'html' \| 'markdown'` | `'html'` | 输出格式:HTML 适合浏览器打印为 PDF,Markdown 适合仓库内查看 |
|
|
196
|
+
| `output` | `string` | `'api-docs.html'` | 输出文件名,相对 `outputDir` |
|
|
197
|
+
| `title` | `string` | OpenAPI `info.title` | 文档标题 |
|
|
198
|
+
| `companyName` | `string` | 无 | 封面上的公司名称(仅 HTML) |
|
|
199
|
+
| `template` | `string` | 内置模板 | 自定义 HTML 模板路径(仅 HTML)。优先级:`template` 配置 > 项目根目录 `.swagger.docs.html` > 内置默认模板 |
|
|
200
|
+
| `theme` | `string` | 无 | 自定义 CSS 文件路径,覆盖文档样式(仅 HTML) |
|
|
201
|
+
|
|
202
|
+
#### HTML 文档
|
|
203
|
+
|
|
204
|
+
输出为带书本风格的 HTML 页面,包含:
|
|
205
|
+
- **封面页**:A4 整页,显示公司名称(如配置)、API 名称和版本号
|
|
206
|
+
- **目录**:方法 + 路径 | 点线 | 摘要,点击跳转到对应接口
|
|
207
|
+
- **接口卡片**:包含路径参数、查询参数、请求体、响应体的字段表格(名称 / 类型 / 必填 / 描述)
|
|
208
|
+
|
|
209
|
+
可通过项目根目录的 `.swagger.docs.html` 文件自定义文档样式。如果设置了 `apiDocs.template`,则优先使用该路径的模板文件。
|
|
210
|
+
|
|
211
|
+
#### Markdown 文档
|
|
212
|
+
|
|
213
|
+
输出为 `.md` 文件,包含:
|
|
214
|
+
- 封面区域:公司名称(如配置)、API 名称和版本号
|
|
215
|
+
- 目录(Table of Contents):所有接口的锚点链接列表
|
|
216
|
+
- 每个接口的详细说明:HTTP 方法 + 路径、描述、参数表格和响应表格
|
|
217
|
+
|
|
218
|
+
适合直接在代码仓库中查看或用于 GitBook、VuePress 等文档工具。```
|
|
@@ -1,7 +1,11 @@
|
|
|
1
1
|
import {
|
|
2
|
+
buildDefaultMethodName,
|
|
3
|
+
buildTypeName,
|
|
4
|
+
sanitizeIdentifier,
|
|
5
|
+
sanitizeSchemaTypeName,
|
|
2
6
|
schemaToTs,
|
|
3
7
|
toTypePropertyName
|
|
4
|
-
} from "./chunk-
|
|
8
|
+
} from "./chunk-EAGONRXV.js";
|
|
5
9
|
|
|
6
10
|
// src/generate.ts
|
|
7
11
|
import path4 from "path";
|
|
@@ -161,28 +165,6 @@ function groupByController(operations) {
|
|
|
161
165
|
}, {});
|
|
162
166
|
}
|
|
163
167
|
|
|
164
|
-
// src/utils/naming.ts
|
|
165
|
-
function toPascalCase(value) {
|
|
166
|
-
return value.split(/[^a-zA-Z0-9]+/).filter(Boolean).map((segment) => segment[0].toUpperCase() + segment.slice(1)).join("");
|
|
167
|
-
}
|
|
168
|
-
function sanitizePathSegment(value) {
|
|
169
|
-
return value.replace(/^\//, "").replace(/\{|\}/g, "").replace(/[^a-zA-Z0-9/_-]/g, "").replace(/\/+/g, "/");
|
|
170
|
-
}
|
|
171
|
-
function sanitizeIdentifier(value) {
|
|
172
|
-
const normalized = value.replace(/[^a-zA-Z0-9_$]+/g, "_").replace(/_+/g, "_").replace(/^_+|_+$/g, "");
|
|
173
|
-
if (!normalized) {
|
|
174
|
-
return "generated_api";
|
|
175
|
-
}
|
|
176
|
-
return /^[0-9]/.test(normalized) ? `api_${normalized}` : normalized;
|
|
177
|
-
}
|
|
178
|
-
function buildDefaultMethodName(apiPath, method) {
|
|
179
|
-
const cleaned = sanitizePathSegment(apiPath).replace(/\//g, "_").replace(/_+/g, "_");
|
|
180
|
-
return sanitizeIdentifier([method.toLowerCase(), cleaned || "root"].join("_"));
|
|
181
|
-
}
|
|
182
|
-
function buildTypeName(functionName, suffix) {
|
|
183
|
-
return `${toPascalCase(functionName)}${suffix}`;
|
|
184
|
-
}
|
|
185
|
-
|
|
186
168
|
// src/core/parsePaths.ts
|
|
187
169
|
var HTTP_METHODS = ["get", "post", "put", "patch", "delete", "options", "head"];
|
|
188
170
|
function collectReferencedTypeNames(schema, collected = /* @__PURE__ */ new Set()) {
|
|
@@ -192,7 +174,7 @@ function collectReferencedTypeNames(schema, collected = /* @__PURE__ */ new Set(
|
|
|
192
174
|
if (schema.$ref) {
|
|
193
175
|
const typeName = schema.$ref.split("/").pop();
|
|
194
176
|
if (typeName) {
|
|
195
|
-
collected.add(typeName);
|
|
177
|
+
collected.add(sanitizeSchemaTypeName(typeName));
|
|
196
178
|
}
|
|
197
179
|
}
|
|
198
180
|
for (const child of schema.anyOf ?? []) {
|
|
@@ -628,7 +610,7 @@ function renderOperationTypes(operation) {
|
|
|
628
610
|
}
|
|
629
611
|
function renderComponentSchemas(document) {
|
|
630
612
|
return Object.entries(document.components?.schemas ?? {}).map(([name, schema]) => {
|
|
631
|
-
return renderComponentSchema(name, schema);
|
|
613
|
+
return renderComponentSchema(sanitizeSchemaTypeName(name), schema);
|
|
632
614
|
});
|
|
633
615
|
}
|
|
634
616
|
function toJSDocType(typeText) {
|
|
@@ -645,7 +627,7 @@ function generateTypesFile(documentMap, operations, config) {
|
|
|
645
627
|
const moduleName = config.moduleName?.(docUrl) ?? "services";
|
|
646
628
|
parts2.push(`// Types from ${moduleName}`);
|
|
647
629
|
for (const [name, schema] of Object.entries(document.components?.schemas ?? {})) {
|
|
648
|
-
parts2.push(`/** @typedef {${toJSDocType(schemaToTs(schema))}} ${name} */`);
|
|
630
|
+
parts2.push(`/** @typedef {${toJSDocType(schemaToTs(schema))}} ${sanitizeSchemaTypeName(name)} */`);
|
|
649
631
|
}
|
|
650
632
|
}
|
|
651
633
|
for (const operation of operations) {
|
|
@@ -810,10 +792,10 @@ async function generateFromConfig(cwd = process.cwd()) {
|
|
|
810
792
|
let content;
|
|
811
793
|
const docFile = path4.join(cwd, config.outputDir, config.apiDocs.output);
|
|
812
794
|
if (config.apiDocs.format === "markdown") {
|
|
813
|
-
const { generateApiDocsMd } = await import("./genApiDocsMd-
|
|
795
|
+
const { generateApiDocsMd } = await import("./genApiDocsMd-UOK4S7BK.js");
|
|
814
796
|
content = generateApiDocsMd(documentMap, operations, config);
|
|
815
797
|
} else {
|
|
816
|
-
const { generateApiDocsHtml, DEFAULT_TEMPLATE } = await import("./genApiDocsHtml-
|
|
798
|
+
const { generateApiDocsHtml, DEFAULT_TEMPLATE } = await import("./genApiDocsHtml-ZM2XY5P2.js");
|
|
817
799
|
const templateFile = path4.join(cwd, ".swagger.docs.html");
|
|
818
800
|
if (!existsSync2(templateFile)) {
|
|
819
801
|
await writeTextFile(templateFile, DEFAULT_TEMPLATE);
|
|
@@ -1,10 +1,50 @@
|
|
|
1
|
+
// src/utils/naming.ts
|
|
2
|
+
import { pinyin } from "pinyin-pro";
|
|
3
|
+
function toPascalCase(value) {
|
|
4
|
+
return value.split(/[^a-zA-Z0-9]+/).filter(Boolean).map((segment) => segment[0].toUpperCase() + segment.slice(1)).join("");
|
|
5
|
+
}
|
|
6
|
+
function sanitizePathSegment(value) {
|
|
7
|
+
return value.replace(/^\//, "").replace(/\{|\}/g, "").replace(/[^a-zA-Z0-9/_-]/g, "").replace(/\/+/g, "/");
|
|
8
|
+
}
|
|
9
|
+
function sanitizeIdentifier(value) {
|
|
10
|
+
const normalized = value.replace(/[^a-zA-Z0-9_$]+/g, "_").replace(/_+/g, "_").replace(/^_+|_+$/g, "");
|
|
11
|
+
if (!normalized) {
|
|
12
|
+
return "generated_api";
|
|
13
|
+
}
|
|
14
|
+
return /^[0-9]/.test(normalized) ? `api_${normalized}` : normalized;
|
|
15
|
+
}
|
|
16
|
+
function buildDefaultMethodName(apiPath, method) {
|
|
17
|
+
const cleaned = sanitizePathSegment(apiPath).replace(/\//g, "_").replace(/_+/g, "_");
|
|
18
|
+
return sanitizeIdentifier([method.toLowerCase(), cleaned || "root"].join("_"));
|
|
19
|
+
}
|
|
20
|
+
function buildTypeName(functionName, suffix) {
|
|
21
|
+
return `${toPascalCase(functionName)}${suffix}`;
|
|
22
|
+
}
|
|
23
|
+
function sanitizeSchemaTypeName(raw) {
|
|
24
|
+
let result = "";
|
|
25
|
+
for (const ch of raw) {
|
|
26
|
+
if ("\xAB\xBB\uFF08\uFF09()".includes(ch)) {
|
|
27
|
+
result += "_";
|
|
28
|
+
} else if (/[一-鿿]/.test(ch)) {
|
|
29
|
+
const py = pinyin(ch, { toneType: "none" });
|
|
30
|
+
result += py[0].toUpperCase() + py.slice(1);
|
|
31
|
+
} else {
|
|
32
|
+
result += ch;
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
result = result.replace(/[^A-Za-z0-9_]/g, "");
|
|
36
|
+
result = result.replace(/_+/g, "_").replace(/^_+|_+$/g, "");
|
|
37
|
+
return result || "GeneratedType";
|
|
38
|
+
}
|
|
39
|
+
|
|
1
40
|
// src/generators/schemaToTs.ts
|
|
2
41
|
function formatPropertyName(name) {
|
|
3
42
|
return /^[A-Za-z_$][A-Za-z0-9_$]*$/.test(name) ? name : JSON.stringify(name);
|
|
4
43
|
}
|
|
5
44
|
function refToTypeName(ref) {
|
|
6
45
|
const parts = ref.split("/");
|
|
7
|
-
|
|
46
|
+
const raw = parts[parts.length - 1] || "unknown";
|
|
47
|
+
return sanitizeSchemaTypeName(raw);
|
|
8
48
|
}
|
|
9
49
|
function schemaToTs(schema) {
|
|
10
50
|
if (!schema) {
|
|
@@ -59,6 +99,10 @@ function toTypePropertyName(name) {
|
|
|
59
99
|
}
|
|
60
100
|
|
|
61
101
|
export {
|
|
102
|
+
sanitizeIdentifier,
|
|
103
|
+
buildDefaultMethodName,
|
|
104
|
+
buildTypeName,
|
|
105
|
+
sanitizeSchemaTypeName,
|
|
62
106
|
schemaToTs,
|
|
63
107
|
toTypePropertyName
|
|
64
108
|
};
|
package/dist/cli.js
CHANGED
package/dist/index.js
CHANGED
package/package.json
CHANGED
|
@@ -1,42 +1,43 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "swgto-ts",
|
|
3
|
-
"version": "3.
|
|
4
|
-
"description": "Generate API request files from OpenAPI 3.x documents.",
|
|
5
|
-
"license": "MIT",
|
|
6
|
-
"type": "module",
|
|
7
|
-
"bin": {
|
|
8
|
-
"swgto": "./dist/cli.js"
|
|
9
|
-
},
|
|
10
|
-
"main": "./dist/index.js",
|
|
11
|
-
"module": "./dist/index.js",
|
|
12
|
-
"types": "./dist/index.d.ts",
|
|
13
|
-
"files": [
|
|
14
|
-
"dist"
|
|
15
|
-
],
|
|
16
|
-
"scripts": {
|
|
17
|
-
"build": "tsup src/index.ts src/cli.ts --format esm --dts --clean",
|
|
18
|
-
"dev": "tsup src/index.ts src/cli.ts --format esm --dts --watch",
|
|
19
|
-
"test": "tsx ./src/cli.ts"
|
|
20
|
-
},
|
|
21
|
-
"keywords": [
|
|
22
|
-
"openapi",
|
|
23
|
-
"swagger",
|
|
24
|
-
"typescript",
|
|
25
|
-
"generator",
|
|
26
|
-
"cli"
|
|
27
|
-
],
|
|
28
|
-
"engines": {
|
|
29
|
-
"node": ">=18"
|
|
30
|
-
},
|
|
31
|
-
"dependencies": {
|
|
32
|
-
"jiti": "^2.4.2",
|
|
33
|
-
"
|
|
34
|
-
"
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
"
|
|
39
|
-
"
|
|
40
|
-
"
|
|
41
|
-
|
|
42
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"name": "swgto-ts",
|
|
3
|
+
"version": "3.2.0",
|
|
4
|
+
"description": "Generate API request files from OpenAPI 3.x documents.",
|
|
5
|
+
"license": "MIT",
|
|
6
|
+
"type": "module",
|
|
7
|
+
"bin": {
|
|
8
|
+
"swgto": "./dist/cli.js"
|
|
9
|
+
},
|
|
10
|
+
"main": "./dist/index.js",
|
|
11
|
+
"module": "./dist/index.js",
|
|
12
|
+
"types": "./dist/index.d.ts",
|
|
13
|
+
"files": [
|
|
14
|
+
"dist"
|
|
15
|
+
],
|
|
16
|
+
"scripts": {
|
|
17
|
+
"build": "tsup src/index.ts src/cli.ts --format esm --dts --clean",
|
|
18
|
+
"dev": "tsup src/index.ts src/cli.ts --format esm --dts --watch",
|
|
19
|
+
"test": "tsx ./src/cli.ts"
|
|
20
|
+
},
|
|
21
|
+
"keywords": [
|
|
22
|
+
"openapi",
|
|
23
|
+
"swagger",
|
|
24
|
+
"typescript",
|
|
25
|
+
"generator",
|
|
26
|
+
"cli"
|
|
27
|
+
],
|
|
28
|
+
"engines": {
|
|
29
|
+
"node": ">=18"
|
|
30
|
+
},
|
|
31
|
+
"dependencies": {
|
|
32
|
+
"jiti": "^2.4.2",
|
|
33
|
+
"pinyin-pro": "^3.29.4",
|
|
34
|
+
"ts-node": "^10.9.2",
|
|
35
|
+
"tsx": "^4.21.0"
|
|
36
|
+
},
|
|
37
|
+
"devDependencies": {
|
|
38
|
+
"@types/node": "^24.6.0",
|
|
39
|
+
"tsup": "^8.5.0",
|
|
40
|
+
"typescript": "^5.9.3",
|
|
41
|
+
"vitest": "^3.2.4"
|
|
42
|
+
}
|
|
43
|
+
}
|