tsg.config.ts
7.22 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
/**
* each project will use the "requester" function when request remote api
* so this file would be included into your source file when compile
* */
import type { Project } from 'ts-gear';
const projects: Project[] = [
{
/**
* project name
* will used to mkdir in "dest"
*
* 工程名，会在dest指定的文件夹中生成对应的工程名文件夹
* */
name: '',
/**
* the api files will be generated to
* note: this directory is relative to this ts-gear config file
* @example 'service'
*
* 目标文件夹，相对路径以当前'tsg.config.ts'为基准
* */
dest: 'services',
/**
* swagger doc path
* could be remote or local json file
* starts with "http" is remote
* others are dealed local json file
* note: if use local file, the directory is relative to this ts-gear config file
*
* openapi 文档地址，可以是远程的json文件，也可以是本地的json文件
* 如果使用本地文件，相对路径以当前'tsg.config.ts'为基准
* */
source: 'http://localhost:8000/request.json',
// source: 'https://petstore3.swagger.io/api/v3/openapi.json',
// source: './fixture/pet.json',
/**
* request function statement
* change this to import your request function
* read
* https://github.com/superwf/ts-gear/blob/master/src/requester/fetch.ts
* or
* https://github.com/superwf/ts-gear/blob/master/src/requester/axios.ts
* for more details
*
* 加载自己的请求函数，函数内的处理逻辑需要自己定义
* 有fetch与axios两种风格可参考
* https://github.com/superwf/ts-gear/blob/master/src/requester/fetch.ts
* https://github.com/superwf/ts-gear/blob/master/src/requester/axios.ts
*
* @required
* */
importRequesterStatement: 'import {request as requester} from "umi"',
/**
* filter api path
* some project mix too mach useless api
* use this option could avoid those to be written in your api file
*
* 过滤api路径，比如某些工程中，某些api路径是不需要的，可以通过这个选项过滤掉，也可使用函数
* */
// apiFilter: /^\/api/,
// or use function
// apiFilter: ({ pathname }) =>
// pathname.startsWith('/api') || pathname.startsWith('/server'),
/**
* filter api path
* some project mix too mach useless api
* use this option could avoid those to be written in your api file
*
* 是否优先使用 class 而不是 interface
* */
// preferClass: false,
/**
* @default false
* when assigned true, the requester function will receive the "host"
* defined in swagger
*
* 请求的url上是否带有host，跨域请求时需要
* */
// withHost: false,
/**
* @default false
* when assigned true, the requester function will receive the "basePath" defined in swagger
*
* 请求的url上是否带有basePath
* */
// withBasePath: false,
/**
* @default true
* ts-gear try to keep the generic type for all definition
* but real world swagger doc has many bad definition
* if generic type make some error
* assign "false" to this option
* ts-gear will not generate generic type
* the process of generating typescript content will be more stable.
*
* 是否生成泛型，定义规范的文档推荐生成
* 单有很多定义不规范的文档根本无法生成泛型，如果运行时报错，把这个改成false再试试
* */
// keepGeneric: true,
/** if your swagger doc has some non english words in definitions keys or some $ref position,
* choose an engine to transate those words to english
* the translated results are not for human reading, but for program variable names.
* because translation depends on internet, you may need to retry some times to get results successfuly.
* once your api is generated, change to another engine and regenerate new api, the translate output will definitely be different, so the api content will be different too.
*
* most case you don not need this option, try to persuade your teammate to correct the swagger doc to english is a better way.
* if there are unregular charator, and you can not fix it,
* try to use an engine provided by "translation.js"
* "baidu" or "google"
*
* 如果你的swagger文档中有一些非英文字符，或者有$ref的位置，可以选择一个翻译引擎
* */
// translationEngine: 'baidu',
/**
* should export request function option types
*
* 是否导出请求函数的参数类型
* @default false
* */
shouldExportRequestOptionType: true,
/**
* should export request function response types
*
* 是否导出请求函数的返回值类型
* @default false
* */
// shouldExportResponseType: false,
/**
* generate mock data switch
*
* 是否生成mock请求函数，测试环境使用
* @default false
* */
// shouldGenerateMock: false,
/**
* output content prettier config
*
* 输入内容的prettier配置
* */
// prettierConfig: {
// semi: false,
// },
/**
* generate request function name method
*
* 输出函数的函数名自定义方法，如果指定将覆盖默认的生成规则
* */
// generateRequestFunctionName: (arg: GenerateRequestFunctionNameParameter) => string,
/**
* if you need, use this option to generate your function all by your self
*
* 自定义生成的请求函数内容，如果指定将覆盖默认的生成规则
* 这个很少用到，除非有非常特殊的定制需求
* */
// generateRequestFunction?: (arg: GenerateRequestFunctionNameParameter) => string,
/**
* need js file? OK, change this to true
*
* 如果需要输出js而非ts文件，请将这个选项设置为true
* @default false
* */
// transformJS: false,
/**
* use cache
*
* 是否使用缓存，远程文档地址失效需要重新生成时用得到
* @default false
* */
// useCache: false,
/**
* costom the "end of line" character
*
* 定制换行符，之前的版本从当前运行的操作系统获取换行符的行为是错误的，会使不同的人生成的文件内容不一致
* 推荐设置为\n
* 如果有特殊原因，可设置为'auto'，则跟随系统，例如windows则为'\r\n'，mac为'\r'
* @default '\n'
* */
// EOL?: '\n' | '\r' | '\r\n' | 'auto',
/**
* treat all nullable fields as optional
* reference: https://swagger.io/specification/?sbsearch=nullable
* when set true, all fields those do not include "nullable: true" property will be treated as required
*
* nullable为false时是否等同于非必填
* 在一些后端项目中所有字段都是有的，但是他们用nullable来表示此字段是否必填
* 用来影响字段的?生成
* 如果指定为true，则所有没有nullable: true的字段都会被认为是必须的
* @default false
*/
// nullableFalseAsRequired?: boolean
},
];
export default projects;