File tree Expand file tree Collapse file tree 3 files changed +11
-4
lines changed Expand file tree Collapse file tree 3 files changed +11
-4
lines changed Original file line number Diff line number Diff line change @@ -268,11 +268,15 @@ openapi -i ./spec.json -o ./apis
268
268
| attribute | type | description | required |
269
269
| --- | --- | --- | --- |
270
270
| projectId | string | project id | true |
271
+ | apifoxToken | string | [ get] ( https://docs.apifox.com/doc-5723694 ) | true |
271
272
| local | string | language(default: zh-CN ) | false |
272
273
| apifoxVersion | string | default: 2024-03-28, [ current apifox version] ( https://api.apifox.com/v1/versions ) | false |
273
274
| includeTags | \* or string[ ] | default: \* | false |
274
275
| excludeTags | string[ ] | default: [ ] | false |
275
- | apifoxToken | string | [ get] ( https://docs.apifox.com/doc-5723694 ) | true |
276
+ | oasVersion | string | specify the version of the OpenAPI specification used for export, can have values such as "2.0", "3.0" or "3.1" | '3.0' |
277
+ | exportFormat | string | specify the format of the exported OpenAPI file, can have values such as 'JSON' or 'YAML' | 'JSON' |
278
+ | includeApifoxExtensionProperties | boolean | specify whether to include the OpenAPI specification extension fields ` x-apifox ` | false |
279
+ | addFoldersToTags | boolean | specify whether to include the directory name of the interface in the tag field | false |
276
280
277
281
## JSON Schemas
278
282
Original file line number Diff line number Diff line change @@ -270,11 +270,15 @@ openapi --i ./spec.json --o ./apis
270
270
| 属性 | 类型 | 说明 | 必填 |
271
271
| --- | --- | --- | --- |
272
272
| projectId | string | 项目id | true |
273
- | local | string | 语言(默认: zh-CN ) | false |
273
+ | apifoxToken | string | [ 获取] ( https://docs.apifox.com/doc-5723694 ) | true |
274
+ | local | string | 语言(默认: zh-CN) | false |
274
275
| apifoxVersion | string | 默认: 2024-03-28, [ 获取当前版本] ( https://api.apifox.com/v1/versions ) | false |
275
276
| includeTags | \* 或 string[ ] | 默认: \* | false |
276
277
| excludeTags | string[ ] | 默认: [ ] | false |
277
- | apifoxToken | string | [ 获取] ( https://docs.apifox.com/doc-5723694 ) | true |
278
+ | oasVersion | string | 指定用于导出的 OpenAPI 规范的版本,可以有值如 "2.0"、"3.0"、"3.1" | '3.0' |
279
+ | exportFormat | string | 指定导出的 OpenAPI 文件的格式,可以有值如 'JSON' 或 'YAML' | 'JSON' |
280
+ | includeApifoxExtensionProperties | boolean | 指定是否包含 Apifox 的 OpenAPI 规范扩展字段 ` x-apifox ` | false |
281
+ | addFoldersToTags | boolean | 指定是否在标签字段中包含接口的目录名称 | false |
278
282
279
283
## JSON Schemas
280
284
Original file line number Diff line number Diff line change @@ -26,7 +26,6 @@ export const readConfig = async <T = unknown>({
26
26
} else {
27
27
return ( await explorerSync . search ( ) ?. config ) as T ;
28
28
}
29
- // eslint-disable-next-line no-unused-vars
30
29
} catch ( error ) {
31
30
return undefined ;
32
31
}
You can’t perform that action at this time.
0 commit comments