Merge pull request #243 from openapi-ui/main

feat: apifox support, incremental change support, cli concurrency and timeout support, uniquekey filpath support, openapi-ts merge to openapi

Author: rookie-luochao

.changeset/happy-foxes-sip.md

@@ -0,0 +1,5 @@
+---
+'openapi-ts-request': patch
+---
+
+feat: cli concurrency and timeout support and uniquekey filpath support

.changeset/smooth-lights-greet.md

@@ -0,0 +1,5 @@
+---
+'openapi-ts-request': minor
+---
+
+feat: 新增增量修改，方法命名规范，合并openapi-ts和openapi命令

README-en_US.md

@@ -13,6 +13,7 @@ based on [Swagger2/OpenAPI3/Apifox](https://swagger.io/blog/news/whats-new-in-op
 - react-query/vue-query
 - type field label
 - JSON Schemas
+- Apifox Config
 
 docs：[use docs](https://github.com/openapi-ui/openapi-ts-request/issues/100)
 
@@ -25,6 +26,7 @@ docs：[use docs](https://github.com/openapi-ui/openapi-ts-request/issues/100)
 - support filter generate result by tags
 - support JSON/YAML specification
 - support translate chinese tag name to english tag name
+- support direct configuration of `apifox` `token` and `projectId` direct generation
 
 ## Usage
 
@@ -181,9 +183,13 @@ $ openapi --help
 
   Options:
     -V, --version                       output the version number
-    -i, --input <string>                OpenAPI specification, can be a path, url (required)
-    -o, --output <string>               output directory (required)
+    -i, --input <string>                OpenAPI specification, can be a path, url
+    -o, --output <string>               output directory
+    -cfn, --configFileName <string>     config file name
+    -cfp, --configFilePath <string>     config file path
+    -u, --uniqueKey <string>            unique key
     --requestLibPath <string>           custom request lib path, for example: "@/request", "node-fetch" (default: "axios")
+    -f, --full <boolean>                full replacement (default: true)
     --enableLogging <boolean>           open the log (default: false)
     --priorityRule <string>             priority rule, include/exclude/both (default: "include")
     --includeTags <(string|RegExp)[]>   generate code from include tags
@@ -221,6 +227,7 @@ openapi -i ./spec.json -o ./apis
 | schemaPath | yes | string | - | Swagger2/OpenAPI3 URL |
 | serversPath | no | string | './src/apis' | the folder path for the run results |
 | requestLibPath | no | string | 'axios' | custom request lib path, for example: '@/request', 'node-fetch' |
+| full | no | boolean | true | full replacement |
 | enableLogging | no | boolean | false | open the log |
 | priorityRule | no | string | 'include' | priority rule, include/exclude/both |
 | includeTags | no | (string\|RegExp)[] | - | generate code from include tags, priorityRule=include required |
@@ -237,6 +244,7 @@ openapi -i ./spec.json -o ./apis
 | isGenJsonSchemas | no | boolean | false | generate JSON Schemas |
 | mockFolder | no | string | - | mock file path, for example: './mocks' |
 | authorization | no | string | - | docs authorization |
+| apifoxConfig | no | [Apifox Config](#Apifox-Config) | - | apifox configs |
 | nullable | no | boolean | false | null instead of optional |
 | isTranslateToEnglishTag | no | boolean | false | translate chinese tag name to english tag name |
 | isOnlyGenTypeScriptType | no | boolean | false | only generate typescript type |
@@ -255,6 +263,17 @@ openapi -i ./spec.json -o ./apis
 | 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_ |
 
+## Apifox-Config
+
+| attribute | type | description | required |
+| --- | --- | --- | --- |
+| projectId | string | project id | true |
+| local | string | language(default:zh-CN) | false |
+| apifoxVersion | string | default: 2024-03-28, [current apifox version](https://api.apifox.com/v1/versions) | false |
+| includeTags | \* or string[] | default: \* | false |
+| excludeTags | string[] | default: [] | false |
+| apifoxToken | string | [get](https://docs.apifox.com/doc-5723694) | true |
+
 ## JSON Schemas
 
 - default generate JSON Schemas based on [components.schemas](https://spec.openapis.org/oas/latest.html#components-object), JSON Schemas corresponding to [paths](https://spec.openapis.org/oas/latest.html#paths-object) currently need to be parsed by yourself
@@ -275,6 +294,33 @@ currently using [mockjs](http://mockjs.com) to generate mock data, the mocks fil
 
 it is recommended to use a custom request function to adapt to uniapp. you can also use the `@uni-helper/axios-adapter` adapter. for details, see [【use docs 2.2】](https://github.com/openapi-ui/openapi-ts-request/issues/100)
 
+## Notes on Upgrading Older Versions
+
+- Current naming convention changes
+- Incremental changes have been made to the current version and will not affect previous versions.
+- The `openapi-ts` command can be deprecated to use `openapi`
+
+### The configuration follows the naming convention of the old version as follows
+
+```typescript
+import type { APIDataType } from 'openapi-ts-request/dist/generator/type';
+import {
+  genDefaultFunctionName,
+  resolveFunctionName,
+  stripDot,
+} from 'openapi-ts-request/dist/generator/util';
+
+export default {
+  hook: {
+    customFunctionName(data: APIDataType, prefix: string) {
+      if (data.operationId)
+        return resolveFunctionName(stripDot(data.operationId), data.method);
+      return data.method + genDefaultFunctionName(data.path, prefix);
+    },
+  },
+};
+```
+
 ## Contribute
 
 ### Development Environment

README.md

@@ -1,3 +1,5 @@
+<!-- TODO:需要修改文档, 添加参数, 添加apifox的配置支持 -->
+
 ## 介绍
 
 [![GitHub Repo stars](https://img.shields.io/github/stars/openapi-ui/openapi-ts-request?style=social)](https://github.com/openapi-ui/openapi-ts-request) [![npm (scoped)](https://img.shields.io/npm/v/openapi-ts-request)](https://www.npmjs.com/package/openapi-ts-request) ![GitHub tag](https://img.shields.io/github/v/tag/openapi-ui/openapi-ts-request?include_prereleases)
@@ -13,6 +15,7 @@
 - react-query/vue-query
 - 类型字段翻译
 - JSON Schemas
+- Apifox Config
 
 文档：[使用手册](https://github.com/openapi-ui/openapi-ts-request/issues/100)
 
@@ -25,6 +28,7 @@
 - 支持通过 tags 过滤生成结果
 - 支持 JSON/YAML 定义文件
 - 支持将中文 tag 名称翻译为英文 tag 名称
+- 支持直接配置`apifox`的`token`和`projectId`直接生成
 
 ## 使用
 
@@ -181,9 +185,13 @@ $ openapi --help
 
   Options:
     -V, --version                       output the version number
-    -i, --input <string>                OpenAPI specification, can be a path, url (required)
-    -o, --output <string>               output directory (required)
+    -i, --input <string>                OpenAPI specification, can be a path, url
+    -o, --output <string>               output directory
+    -cfn, --configFileName <string>     config file name
+    -cfp, --configFilePath <string>     config file path
+    -u, --uniqueKey <string>            unique key
     --requestLibPath <string>           custom request lib path, for example: "@/request", "node-fetch" (default: "axios")
+    -f, --full <boolean>                full replacement (default: true)
     --enableLogging <boolean>           open the log (default: false)
     --priorityRule <string>             priority rule, include/exclude/both (default: "include")
     --includeTags <(string|RegExp)[]>   generate code from include tags
@@ -221,6 +229,7 @@ openapi --i ./spec.json --o ./apis
 | schemaPath | 是 | string | - | Swagger2/OpenAPI3 地址 |
 | serversPath | 否 | string | './src/apis' | 运行结果文件夹路径 |
 | requestLibPath | 否 | string | 'axios' | 自定义请求方法路径，例如：'@/request'、'node-fetch' |
+| full | 否 | boolean | true | 是否全量替换 |
 | enableLogging | 否 | boolean | false | 是否开启日志 |
 | priorityRule | 否 | string | 'include' | 模式规则，可选include/exclude/both |
 | includeTags | 否 | (string\|RegExp)[] | - | 根据指定的 tags 生成代码, priorityRule=include则必填 |
@@ -237,6 +246,7 @@ openapi --i ./spec.json --o ./apis
 | isGenJsonSchemas | 否 | boolean | false | 是否生成 JSON Schemas |
 | mockFolder | 否 | string | - | mock文件路径，例如：'./mocks' |
 | authorization | 否 | string | - | 文档权限凭证 |
+| apifoxConfig | 否 | [Apifox Config](#Apifox-Config) | - | apifox 配置 |
 | nullable | 否 | boolean | false | 使用 null 代替可选 |
 | isTranslateToEnglishTag | 否 | boolean | false | 将中文 tag 名称翻译成英文 tag 名称 |
 | isOnlyGenTypeScriptType | 否 | boolean | false | 仅生成 typescript 类型 |
@@ -255,6 +265,17 @@ openapi --i ./spec.json --o ./apis
 | 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> _返回为空，则使用默认的方法获取_ |
 
+## Apifox-Config
+
+| 属性 | 类型 | 说明 | 必填 |
+| --- | --- | --- | --- |
+| projectId | string | 项目id | true |
+| local | string | 语言(默认:zh-CN) | false |
+| apifoxVersion | string | 默认: 2024-03-28, [获取当前版本](https://api.apifox.com/v1/versions) | false |
+| includeTags | \* 或 string[] | 默认: \* | false |
+| excludeTags | string[] | 默认: [] | false |
+| apifoxToken | string | [获取](https://docs.apifox.com/doc-5723694) | true |
+
 ## JSON Schemas
 
 - 默认生成 [components.schemas](https://spec.openapis.org/oas/latest.html#components-object) 下面的 JSON Schemas，[paths](https://spec.openapis.org/oas/latest.html#paths-object) 对应的 JSON Schemas 目前需自行解析
@@ -275,6 +296,33 @@ export declare function patchSchema<T extends object>(
 
 适配 uniapp 推荐采用自定义 request 函数的方式，你也可以使用 `@uni-helper/axios-adapter` 适配器，详情见 [【使用手册 2.2】](https://github.com/openapi-ui/openapi-ts-request/issues/100)
 
+## 旧版本升级注意事项
+
+- 当前命名规范修改
+- 当前版本已完成增量修改, 不会影响以前
+- 可以弃用`openapi-ts`命令, 直接使用`openapi`
+
+### 沿用旧版本命名规范配置如下
+
+```typescript
+import type { APIDataType } from 'openapi-ts-request/dist/generator/type';
+import {
+  genDefaultFunctionName,
+  resolveFunctionName,
+  stripDot,
+} from 'openapi-ts-request/dist/generator/util';
+
+export default {
+  hook: {
+    customFunctionName(data: APIDataType, prefix: string) {
+      if (data.operationId)
+        return resolveFunctionName(stripDot(data.operationId), data.method);
+      return data.method + genDefaultFunctionName(data.path, prefix);
+    },
+  },
+};
+```
+
 ## 贡献
 
 ### 环境要求

package.json

@@ -31,6 +31,7 @@
     "lint": "eslint ./src --report-unused-disable-directives --max-warnings=0",
     "lint:fix": "eslint ./src --report-unused-disable-directives --max-warnings=0 --fix",
     "test": "rm -rf ./test/apis/ ./test/mocks && npm run build && cd ./test && node ./test.js && cd ..",
+    "test:new": "npm run build && cd ./test && node ./test.js && cd ..",
     "test:windows": "rimraf ./test/apis/ ./test/mocks && npm run build && cd ./test && node ./test.js && cd ..",
     "prepare": "husky",
     "openapi-ts-request": "openapi-ts"
@@ -56,6 +57,7 @@
     "rimraf": "^6.0.1",
     "swagger2openapi": "^7.0.8",
     "tiny-pinyin": "^1.3.2",
+    "ts-morph": "^25.0.1",
     "tslib": "^2.6.3"
   },
   "devDependencies": {
@@ -80,7 +82,7 @@
     "lint-staged": "^15.3.0",
     "openapi-types": "^12.1.3",
     "ts-node": "^10.9.2",
-    "typescript": "5.7.3"
+    "typescript": "5.8.2"
   },
   "keywords": [
     "openapi",