Merge pull request #225 from openapi-ui/main

feat: 解析枚举描述生成枚举

Author: rookie-luochao

.changeset/tame-tips-press.md

@@ -0,0 +1,5 @@
+---
+'openapi-ts-request': minor
+---
+
+parse enum description to generate enum label

.changeset/tiny-flies-watch.md

@@ -0,0 +1,5 @@
+---
+'openapi-ts-request': patch
+---
+
+perf: perf display number enum label

.changeset/weak-monkeys-hear.md

@@ -0,0 +1,5 @@
+---
+'openapi-ts-request': patch
+---
+
+docs: fix customType hook api

README-en_US.md

@@ -87,7 +87,6 @@ src/apis/app #app interface
 
 ```typescript
 // src/apis/pet.ts
-
 /* eslint-disable */
 // @ts-ignore
 import request from 'axios';
@@ -205,6 +204,7 @@ $ openapi --help
     --isTranslateToEnglishTag <boolean> translate chinese tag name to english tag name (default: false)
     --isOnlyGenTypeScriptType <boolean> only generate typescript type (default: false)
     --isCamelCase <boolean>             camelCase naming of controller files and request client (default: true)
+    --isSupportParseEnumDesc <boolean>  parse enum description to generate enum label (default: false)
     -h, --help                          display help for command
 ```
 
@@ -241,6 +241,7 @@ openapi -i ./spec.json -o ./apis
 | isTranslateToEnglishTag | no | boolean | false | translate chinese tag name to english tag name |
 | isOnlyGenTypeScriptType | no | boolean | false | only generate typescript type |
 | isCamelCase | no | boolean | true | camelCase naming of controller files and request client |
+| isSupportParseEnumDesc | no | boolean | false | parse enum description to generate enum label, format example: `UserRole:User(Normal User)=0,Agent(Agent)=1,Admin(Administrator)=2` |
 | hook | no | [Custom Hook](#Custom-Hook) | - | custom hook |
 
 ## Custom Hook
@@ -251,7 +252,7 @@ openapi -i ./spec.json -o ./apis
 | customFunctionName | (data: APIDataType) => string | custom request client function name |
 | customTypeName | (data: APIDataType) => string | custom type name |
 | customClassName | (tagName: string) => string | custom tag name |
-| customType | (<br>schemaObject: SchemaObject \| ReferenceObject,<br>namespace: string,<br>originGetType:(schemaObject: SchemaObject \| ReferenceObject, namespace: string) => string,<br>) => string | custom type <br> _returning a non-string will use the default method to get the type_ |
+| customType | ({<br>schemaObject: SchemaObject \| ReferenceObject,<br>namespace: string,<br>originGetType:(schemaObject: SchemaObject \| ReferenceObject, namespace: string, schemas?: ComponentsObject['schemas']) => string,<br>schemas?: ComponentsObject['schemas'],<br>}) => string | custom type <br> _returning a non-string will use the default method to get the type_ |
 | customFileNames | (<br>operationObject: OperationObject,<br>apiPath: string,<br>apiMethod: string,<br>) => string[] | custom generate request client controller file name, can return multiple: generate multiple files. <br> _if the return value is empty, the default getFileNames is used_ |
 
 ## JSON Schemas

README.md

@@ -87,7 +87,6 @@ src/apis/pet.ts #接口文件
 
 ```typescript
 // src/apis/pet.ts
-
 /* eslint-disable */
 // @ts-ignore
 import request from 'axios';
@@ -205,6 +204,7 @@ $ openapi --help
     --isTranslateToEnglishTag <boolean> translate chinese tag name to english tag name (default: false)
     --isOnlyGenTypeScriptType <boolean> only generate typescript type (default: false)
     --isCamelCase <boolean>             camelCase naming of controller files and request client (default: true)
+    --isSupportParseEnumDesc <boolean>  parse enum description to generate enum label (default: false)
     -h, --help                          display help for command
 ```
 
@@ -241,6 +241,7 @@ openapi --i ./spec.json --o ./apis
 | isTranslateToEnglishTag | 否 | boolean | false | 将中文 tag 名称翻译成英文 tag 名称 |
 | isOnlyGenTypeScriptType | 否 | boolean | false | 仅生成 typescript 类型 |
 | isCamelCase | 否 | boolean | true | 小驼峰命名文件和请求函数 |
+| isSupportParseEnumDesc | 否 | boolean | false | 解析枚举描述生成枚举标签，格式参考：`系统用户角色:User(普通用户)=0,Agent(经纪人)=1,Admin(管理员)=2` |
 | hook | 否 | [Custom Hook](#Custom-Hook) | - | 自定义 hook |
 
 ## 自定义 Hook
@@ -251,7 +252,7 @@ openapi --i ./spec.json --o ./apis
 | customFunctionName | (data: APIDataType) => string | 自定义请求方法函数名称 |
 | customTypeName | (data: APIDataType) => string | 自定义类型名称 |
 | customClassName | (tagName: string) => string | 自定义标签名 |
-| customType | (<br>schemaObject: SchemaObject \| ReferenceObject,<br>namespace: string,<br>originGetType:(schemaObject: SchemaObject \| ReferenceObject, namespace: string) => string,<br>) => string | 自定义类型 <br> _返回非字符串将使用默认方法获取type_ |
+| customType | ({<br>schemaObject: SchemaObject \| ReferenceObject,<br>namespace: string,<br>originGetType:(schemaObject: SchemaObject \| ReferenceObject, namespace: string, schemas?: ComponentsObject['schemas']) => string,<br>schemas?: ComponentsObject['schemas'],<br>}) => string | 自定义类型 <br> _返回非字符串将使用默认方法获取type_ |
 | customFileNames | (<br>operationObject: OperationObject,<br>apiPath: string,<br>apiMethod: string,<br>) => string[] | 自定义生成的请求客户端文件名称，可以返回多个文件名称的数组(表示生成多个文件). <br> _返回为空，则使用默认的方法获取_ |
 
 ## JSON Schemas

package.json

@@ -80,7 +80,7 @@
     "lint-staged": "^15.3.0",
     "openapi-types": "^12.1.3",
     "ts-node": "^10.9.2",
-    "typescript": "5.7.2"
+    "typescript": "5.7.3"
   },
   "keywords": [
     "openapi",