Skip to content

Commit 9155982

Browse files
docs: update readme
1 parent b977c3f commit 9155982

File tree

3 files changed

+11
-4
lines changed

3 files changed

+11
-4
lines changed

README-en_US.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -268,11 +268,15 @@ openapi -i ./spec.json -o ./apis
268268
| attribute | type | description | required |
269269
| --- | --- | --- | --- |
270270
| projectId | string | project id | true |
271+
| apifoxToken | string | [get](https://docs.apifox.com/doc-5723694) | true |
271272
| local | string | language(default:zh-CN) | false |
272273
| apifoxVersion | string | default: 2024-03-28, [current apifox version](https://api.apifox.com/v1/versions) | false |
273274
| includeTags | \* or string[] | default: \* | false |
274275
| 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 |
276280

277281
## JSON Schemas
278282

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -270,11 +270,15 @@ openapi --i ./spec.json --o ./apis
270270
| 属性 | 类型 | 说明 | 必填 |
271271
| --- | --- | --- | --- |
272272
| 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 |
274275
| apifoxVersion | string | 默认: 2024-03-28, [获取当前版本](https://api.apifox.com/v1/versions) | false |
275276
| includeTags | \* 或 string[] | 默认: \* | false |
276277
| 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 |
278282

279283
## JSON Schemas
280284

src/readConfig.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@ export const readConfig = async <T = unknown>({
2626
} else {
2727
return (await explorerSync.search()?.config) as T;
2828
}
29-
// eslint-disable-next-line no-unused-vars
3029
} catch (error) {
3130
return undefined;
3231
}

0 commit comments

Comments
 (0)