openapi-ts-request 0.13.4 → 1.0.0

package/README.md

@@ -6,10 +6,11 @@
 
 根据 [Swagger2/OpenAPI3/Apifox](https://swagger.io/blog/news/whats-new-in-openapi-3-0/) 文档生成:
 
-- TS 类型
-- 客户端请求函数
+- TypeScript/JavaScript
+- 客户端请求函数(支持任意客户端)
 - 模拟请求响应服务
 - 枚举和枚举翻译
+- react-query
 - 类型字段翻译
 - JSON Schemas
 
@@ -18,9 +19,9 @@
 ## 功能
 
 - 支持 Swagger2.0/OpenAPI/Apifox 3.0,3.1 定义
-- 生成 TS 类型, 请求客户端, 请求模拟服务, 枚举, 类型字段翻译, JSON Schemas
+- 生成 TypeScript/JavaScript, 请求客户端(支持任意客户端), 请求模拟服务, 枚举和枚举翻译, react-query, 类型字段翻译, JSON Schemas
 - 支持通过 npx、CLI、Nodejs 的方式使用
-- 支持自定义请求工具函数, 支持 Fetch、Axios、[UniApp-Request](https://github.com/openapi-ui/openapi-ts-request/issues/46)、Node.js、XHR 客户端
+- 支持自定义请求工具函数, 支持 Fetch、Axios、[UniApp-Request](https://github.com/openapi-ui/openapi-ts-request/issues/46)、Taro-Request、Node.js、XHR 客户端
 - 支持通过 tags 过滤生成结果
 - 支持 JSON/YAML 定义文件
 - 支持将中文 tag 名称翻译为英文 tag 名称
@@ -94,10 +95,13 @@ import request from 'axios';
 import * as API from './types';
 
 /** Update an existing pet PUT /pet */
-export async function updatePet(
-  body: API.Pet,
-  options?: { [key: string]: unknown }
-) {
+export async function updatePet({
+  body,
+  options,
+}: {
+  body: API.Pet;
+  options?: { [key: string]: unknown };
+}) {
   return request<unknown>(`/pet`, {
     method: 'PUT',
     headers: {
@@ -177,31 +181,30 @@ $ openapi --help
   Usage: openapi [options]
 
   Options:
-    -V, --version                      output the version number
-    -i, --input <string>               OpenAPI specification, can be a path, url (required)
-    -o, --output <string>              output directory (required)
-    --requestLibPath <string>          custom request lib path, for example: "@/request", "node-fetch" (default: "axios")
-    --enableLogging <boolean>          open the log (default: false)
-    --priorityRule <string>            priority rule, include/exclude/both (default: "include")
-    --includeTags <(string|RegExp)[]>  generate code from include tags
-    --includePaths <(string|RegExp)[]> generate code from include paths
-    --excludeTags <(string|RegExp)[]>  generate code from exclude tags
-    --excludePaths <(string|RegExp)[]> generate code from exclude paths
-    --requestOptionsType <string>      custom request method options parameter type (default: "{ [key:
-                                      string]: unknown }")
-    --requestImportStatement <string>  custom request import statement, for example: "const request =
-                                      require('@/request')"
-    --apiPrefix <string>               custom the prefix of the api path, for example: "api"(variable),
-                                      "'api'"(string)
-    --isDisplayTypeLabel <boolean>     generate label matching type field (default: false)
-    --isGenJsonSchemas <boolean>       generate JSON Schemas (default: false)
-    --mockFolder <string>              mock file path, for example: './mocks'
-    --authorization <string>           docs authorization
-    --nullable <boolean>               null instead of optional (default: false)
-    --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)
-    -h, --help                         display help for command
+    -V, --version                       output the version number
+    -i, --input <string>                OpenAPI specification, can be a path, url (required)
+    -o, --output <string>               output directory (required)
+    --requestLibPath <string>           custom request lib path, for example: "@/request", "node-fetch" (default: "axios")
+    --enableLogging <boolean>           open the log (default: false)
+    --priorityRule <string>             priority rule, include/exclude/both (default: "include")
+    --includeTags <(string|RegExp)[]>   generate code from include tags
+    --includePaths <(string|RegExp)[]>  generate code from include paths
+    --excludeTags <(string|RegExp)[]>   generate code from exclude tags
+    --excludePaths <(string|RegExp)[]>  generate code from exclude paths
+    --requestOptionsType <string>       custom request method options parameter type (default: "{ [key: string]: unknown }")
+    --requestImportStatement <string>   custom request import statement, for example: "const request = require('@/request')"
+    --apiPrefix <string>                custom the prefix of the api path, for example: "api"(variable), "'api'"(string)
+    --isGenReactQuery <boolean>         generate react-query (default: false)
+    --isGenJavaScript <boolean>         generate JavaScript (default: false)
+    --isDisplayTypeLabel <boolean>      generate label matching type field (default: false)
+    --isGenJsonSchemas <boolean>        generate JSON Schemas (default: false)
+    --mockFolder <string>               mock file path, for example: './mocks'
+    --authorization <string>            docs authorization
+    --nullable <boolean>                null instead of optional (default: false)
+    --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)
+    -h, --help                          display help for command
 ```
 
 运行：
@@ -226,6 +229,8 @@ openapi --i ./spec.json --o ./apis
 | requestOptionsType | 否 | string | '{ [key: string]: unknown }' | 自定义请求方法 options 参数类型 |
 | requestImportStatement | 否 | string | - | 自定义请求方法表达式，例如："const request = require('@/request')" |
 | apiPrefix | 否 | string | - | api path的前缀，例如：'api'(动态变量), "'api'"(字符串) |
+| isGenReactQuery | 否 | boolean | false | 是否生成 react-query |
+| isGenJavaScript | 否 | boolean | false | 是否生成 JavaScript |
 | isDisplayTypeLabel | 否 | boolean | false | 是否生成 type 对应的label |
 | isGenJsonSchemas | 否 | boolean | false | 是否生成 JSON Schemas |
 | mockFolder | 否 | string | - | mock文件路径，例如：'./mocks' |

package/dist/bin/openapi.js

@@ -22,6 +22,8 @@ const params = commander_1.program
     .option('--requestOptionsType <string>', 'custom request method options parameter type (default: "{ [key: string]: unknown }")')
     .option('--requestImportStatement <string>', `custom request import statement, for example: "const request = require('@/request')"`)
     .option('--apiPrefix <string>', `custom the prefix of the api path, for example: "api"(variable), "'api'"(string)`)
+    .option('--isGenReactQuery <boolean>', 'generate react-query', false)
+    .option('--isGenJavaScript <boolean>', 'generate JavaScript', false)
     .option('--isDisplayTypeLabel <boolean>', 'generate label matching type field', false)
     .option('--isGenJsonSchemas <boolean>', 'generate JSON Schemas', false)
     .option('--mockFolder <string>', 'mock file path')
@@ -56,6 +58,8 @@ function run() {
                 excludePaths: params.excludePaths,
                 requestOptionsType: params.requestOptionsType,
                 apiPrefix: params.apiPrefix,
+                isGenReactQuery: JSON.parse(params.isGenReactQuery) === true,
+                isGenJavaScript: JSON.parse(params.isGenJavaScript) === true,
                 isDisplayTypeLabel: JSON.parse(params.isDisplayTypeLabel) === true,
                 isGenJsonSchemas: JSON.parse(params.isGenJsonSchemas) === true,
                 mockFolder: params.mockFolder,

package/dist/generator/config.d.ts

@@ -5,13 +5,15 @@ export declare const interfaceFileName = "types";
 export declare const displayEnumLabelFileName = "displayEnumLabel";
 export declare const displayTypeLabelFileName = "displayTypeLabel";
 export declare const schemaFileName = "schema";
+export declare const reactQueryFileName = "reactquery";
 export declare enum TypescriptFileType {
     interface = "interface",
     serviceController = "serviceController",
     serviceIndex = "serviceIndex",
     displayEnumLabel = "displayEnumLabel",
     displayTypeLabel = "displayTypeLabel",
-    schema = "schema"
+    schema = "schema",
+    reactQuery = "reactQuery"
 }
 export declare const DEFAULT_SCHEMA: SchemaObject;
 export declare const DEFAULT_PATH_PARAM: ParameterObject & Dictionary<unknown>;
@@ -32,3 +34,7 @@ export declare enum parametersInsEnum {
 export declare const parametersIn: string[];
 export declare const numberEnum: string[];
 export declare const lineBreakReg: RegExp;
+export declare enum LangType {
+    ts = "ts",
+    js = "js"
+}

package/dist/generator/config.js

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.lineBreakReg = exports.numberEnum = exports.parametersIn = exports.parametersInsEnum = exports.methods = exports.DEFAULT_PATH_PARAM = exports.DEFAULT_SCHEMA = exports.TypescriptFileType = exports.schemaFileName = exports.displayTypeLabelFileName = exports.displayEnumLabelFileName = exports.interfaceFileName = exports.serviceEntryFileName = void 0;
+exports.LangType = exports.lineBreakReg = exports.numberEnum = exports.parametersIn = exports.parametersInsEnum = exports.methods = exports.DEFAULT_PATH_PARAM = exports.DEFAULT_SCHEMA = exports.TypescriptFileType = exports.reactQueryFileName = exports.schemaFileName = exports.displayTypeLabelFileName = exports.displayEnumLabelFileName = exports.interfaceFileName = exports.serviceEntryFileName = void 0;
 exports.serviceEntryFileName = 'index';
 exports.interfaceFileName = 'types';
 exports.displayEnumLabelFileName = 'displayEnumLabel';
 exports.displayTypeLabelFileName = 'displayTypeLabel';
 exports.schemaFileName = 'schema';
+exports.reactQueryFileName = 'reactquery';
 var TypescriptFileType;
 (function (TypescriptFileType) {
     TypescriptFileType["interface"] = "interface";
@@ -14,6 +15,7 @@ var TypescriptFileType;
     TypescriptFileType["displayEnumLabel"] = "displayEnumLabel";
     TypescriptFileType["displayTypeLabel"] = "displayTypeLabel";
     TypescriptFileType["schema"] = "schema";
+    TypescriptFileType["reactQuery"] = "reactQuery";
 })(TypescriptFileType || (exports.TypescriptFileType = TypescriptFileType = {}));
 exports.DEFAULT_SCHEMA = {
     type: 'object',
@@ -59,3 +61,8 @@ exports.numberEnum = [
 ];
 // 匹配换行符的正则
 exports.lineBreakReg = /[\r\n]+/g;
+var LangType;
+(function (LangType) {
+    LangType["ts"] = "ts";
+    LangType["js"] = "js";
+})(LangType || (exports.LangType = LangType = {}));

package/dist/generator/serviceGenarator.d.ts

@@ -4,7 +4,6 @@ import { ControllerType, ISchemaItem, TagAPIDataType } from './type';
 export default class ServiceGenerator {
     protected apiData: TagAPIDataType;
     protected classNameList: ControllerType[];
-    protected finalPath: string;
     protected config: GenerateServiceProps;
     protected openAPIData: OpenAPIObject;
     protected schemaList: ISchemaItem[];

package/dist/generator/serviceGenarator.js

@@ -20,7 +20,6 @@ class ServiceGenerator {
         this.apiData = {};
         this.classNameList = [];
         this.schemaList = [];
-        this.finalPath = '';
         this.config = Object.assign({ templatesFolder: (0, path_1.join)(__dirname, '../../', 'templates') }, config);
         this.generateInfoLog();
         const includeTags = ((_a = this.config) === null || _a === void 0 ? void 0 : _a.includeTags) || [];
@@ -141,17 +140,21 @@ class ServiceGenerator {
         catch (error) {
             (0, log_1.default)(`🚥 api 生成失败: ${error}`);
         }
+        const isOnlyGenTypeScriptType = this.config.isOnlyGenTypeScriptType;
+        const isGenJavaScript = this.config.isGenJavaScript;
         // 处理重复的 typeName
         const interfaceTPConfigs = this.getInterfaceTPConfigs();
         (0, util_1.handleDuplicateTypeNames)(interfaceTPConfigs);
         // 生成 ts 类型声明
-        this.genFileFromTemplate(`${config_1.interfaceFileName}.ts`, config_1.TypescriptFileType.interface, {
-            nullable: this.config.nullable,
-            list: interfaceTPConfigs,
-        });
+        if (!isGenJavaScript) {
+            this.genFileFromTemplate(`${config_1.interfaceFileName}.ts`, config_1.TypescriptFileType.interface, {
+                nullable: this.config.nullable,
+                list: interfaceTPConfigs,
+            });
+        }
         // 生成枚举翻译
         const enums = (0, lodash_1.filter)(interfaceTPConfigs, (item) => item.isEnum);
-        if (!this.config.isOnlyGenTypeScriptType && !(0, lodash_1.isEmpty)(enums)) {
+        if (!isGenJavaScript && !isOnlyGenTypeScriptType && !(0, lodash_1.isEmpty)(enums)) {
             this.genFileFromTemplate(`${config_1.displayEnumLabelFileName}.ts`, config_1.TypescriptFileType.displayEnumLabel, {
                 list: enums,
                 namespace: this.config.namespace,
@@ -160,7 +163,8 @@ class ServiceGenerator {
         }
         const displayTypeLabels = (0, lodash_1.filter)(interfaceTPConfigs, (item) => !item.isEnum);
         // 生成 type 翻译
-        if (!this.config.isOnlyGenTypeScriptType &&
+        if (!isGenJavaScript &&
+            !isOnlyGenTypeScriptType &&
             this.config.isDisplayTypeLabel &&
             !(0, lodash_1.isEmpty)(displayTypeLabels)) {
             this.genFileFromTemplate(`${config_1.displayTypeLabelFileName}.ts`, config_1.TypescriptFileType.displayTypeLabel, {
@@ -169,39 +173,51 @@ class ServiceGenerator {
                 interfaceFileName: config_1.interfaceFileName,
             });
         }
-        if (!this.config.isOnlyGenTypeScriptType) {
+        if (!isOnlyGenTypeScriptType) {
             const prettierError = [];
             // 生成 service controller 文件
             this.getServiceTPConfigs().forEach((tp) => {
-                const hasError = this.genFileFromTemplate((0, util_1.getFinalFileName)(`${tp.className}.ts`), config_1.TypescriptFileType.serviceController, Object.assign({ namespace: this.config.namespace, requestOptionsType: this.config.requestOptionsType, requestImportStatement: this.config.requestImportStatement, interfaceFileName: config_1.interfaceFileName }, tp));
+                const hasError = this.genFileFromTemplate(isGenJavaScript
+                    ? (0, util_1.getFinalFileName)(`${tp.className}.js`)
+                    : (0, util_1.getFinalFileName)(`${tp.className}.ts`), config_1.TypescriptFileType.serviceController, Object.assign({ namespace: this.config.namespace, requestOptionsType: this.config.requestOptionsType, requestImportStatement: this.config.requestImportStatement, interfaceFileName: config_1.interfaceFileName }, tp));
                 prettierError.push(hasError);
+                if (this.config.isGenReactQuery) {
+                    this.genFileFromTemplate(isGenJavaScript
+                        ? (0, util_1.getFinalFileName)(`${tp.className}.${config_1.reactQueryFileName}.js`)
+                        : (0, util_1.getFinalFileName)(`${tp.className}.${config_1.reactQueryFileName}.ts`), config_1.TypescriptFileType.reactQuery, Object.assign({ namespace: this.config.namespace, requestOptionsType: this.config.requestOptionsType, requestImportStatement: this.config.requestImportStatement, interfaceFileName: config_1.interfaceFileName }, tp));
+                }
             });
             if (prettierError.includes(true)) {
                 (0, log_1.default)('🚥 格式化失败，请检查 service controller 文件内可能存在的语法错误');
             }
         }
-        if (!this.config.isOnlyGenTypeScriptType &&
+        if (!isOnlyGenTypeScriptType &&
             this.config.isGenJsonSchemas &&
             !(0, lodash_1.isEmpty)(this.schemaList)) {
             // 处理重复的 schemaName
             (0, util_1.handleDuplicateTypeNames)(this.schemaList);
             // 生成 schema 文件
-            this.genFileFromTemplate(`${config_1.schemaFileName}.ts`, config_1.TypescriptFileType.schema, {
+            this.genFileFromTemplate(isGenJavaScript ? `${config_1.schemaFileName}.js` : `${config_1.schemaFileName}.ts`, config_1.TypescriptFileType.schema, {
                 list: this.schemaList,
             });
         }
         // 生成 service index 文件
-        this.genFileFromTemplate(`${config_1.serviceEntryFileName}.ts`, config_1.TypescriptFileType.serviceIndex, {
+        this.genFileFromTemplate(isGenJavaScript
+            ? `${config_1.serviceEntryFileName}.js`
+            : `${config_1.serviceEntryFileName}.ts`, config_1.TypescriptFileType.serviceIndex, {
             list: this.classNameList,
             namespace: this.config.namespace,
             interfaceFileName: config_1.interfaceFileName,
-            isGenJsonSchemas: !this.config.isOnlyGenTypeScriptType &&
+            genType: isGenJavaScript ? config_1.LangType.js : config_1.LangType.ts,
+            isGenJsonSchemas: !isOnlyGenTypeScriptType &&
                 this.config.isGenJsonSchemas &&
                 !(0, lodash_1.isEmpty)(this.schemaList),
             schemaFileName: config_1.schemaFileName,
-            isDisplayEnumLabel: !this.config.isOnlyGenTypeScriptType && !(0, lodash_1.isEmpty)(enums),
+            isDisplayEnumLabel: !isOnlyGenTypeScriptType && !(0, lodash_1.isEmpty)(enums),
             displayEnumLabelFileName: config_1.displayEnumLabelFileName,
-            isDisplayTypeLabel: !this.config.isOnlyGenTypeScriptType &&
+            isGenReactQuery: this.config.isGenReactQuery,
+            reactQueryFileName: config_1.reactQueryFileName,
+            isDisplayTypeLabel: !isOnlyGenTypeScriptType &&
                 this.config.isDisplayTypeLabel &&
                 !(0, lodash_1.isEmpty)(displayTypeLabels),
             displayTypeLabelFileName: config_1.displayTypeLabelFileName,
@@ -228,7 +244,7 @@ class ServiceGenerator {
                 if ((0, lodash_1.isEmpty)(includeTags) || (!(0, lodash_1.isEmpty)(includeTags) && (0, lodash_1.isEmpty)(tags))) {
                     return;
                 }
-                const flag = this.validateRegexp((0, lodash_1.map)(tags, (tag) => tag.toLowerCase()), includeTags);
+                const flag = this.validateRegexp((0, lodash_1.filter)((0, lodash_1.map)(tags, (tag) => (tag === null || tag === void 0 ? void 0 : tag.toLowerCase) ? tag.toLowerCase() : undefined), (tag) => !!tag), includeTags);
                 if (!flag) {
                     return;
                 }
@@ -434,7 +450,7 @@ class ServiceGenerator {
                 });
             }
             return {
-                genType: 'ts',
+                genType: this.config.isGenJavaScript ? config_1.LangType.js : config_1.LangType.ts,
                 className,
                 instanceName: `${(_b = fileName[0]) === null || _b === void 0 ? void 0 : _b.toLowerCase()}${fileName.slice(1)}`,
                 list: genParams,
@@ -446,9 +462,10 @@ class ServiceGenerator {
         try {
             const template = this.getTemplate(type);
             // 设置输出不转义
-            nunjucks_1.default.configure({
+            const env = nunjucks_1.default.configure({
                 autoescape: false,
             });
+            env.addFilter('capitalizeFirst', util_1.capitalizeFirstLetter);
             return (0, file_1.writeFile)(this.config.serversPath, fileName, nunjucks_1.default.renderString(template, Object.assign({ disableTypeCheck: false }, params)));
         }
         catch (error) {

package/dist/generator/util.d.ts

@@ -21,3 +21,4 @@ export declare function isBinaryArraySchemaObject(schema: unknown): schema is Bi
 export declare function resolveRefs(obj: OpenAPIObject, fields: string[]): unknown;
 export declare function isAllNumeric(arr: any): boolean;
 export declare function isAllNumber(arr: any): boolean;
+export declare function capitalizeFirstLetter(str: string): string;

package/dist/generator/util.js

@@ -21,6 +21,7 @@ exports.isBinaryArraySchemaObject = isBinaryArraySchemaObject;
 exports.resolveRefs = resolveRefs;
 exports.isAllNumeric = isAllNumeric;
 exports.isAllNumber = isAllNumber;
+exports.capitalizeFirstLetter = capitalizeFirstLetter;
 const tslib_1 = require("tslib");
 const lodash_1 = require("lodash");
 const reserved_words_1 = tslib_1.__importDefault(require("reserved-words"));
@@ -159,7 +160,8 @@ function getDefaultType(schemaObject, namespace = '', schemas) {
                 // 不使用 getRefName 函数处理，无法通过 schemas[schemaKey] 获取到schema
                 const schemaKey = getLastRefName(item.$ref);
                 if ((_a = schemas === null || schemas === void 0 ? void 0 : schemas[schemaKey]) === null || _a === void 0 ? void 0 : _a.enum) {
-                    return `I${getDefaultType(item, namespace)}`;
+                    // return `I${getDefaultType(item, namespace)}`;
+                    return getDefaultType(item, namespace);
                 }
             }
             return getDefaultType(item, namespace);
@@ -338,3 +340,6 @@ function isAllNumeric(arr) {
 function isAllNumber(arr) {
     return (0, lodash_1.every)(arr, (item) => (0, lodash_1.isNumber)(item));
 }
+function capitalizeFirstLetter(str) {
+    return str.replace(/^[a-z]/, (match) => match.toUpperCase());
+}

package/dist/index.d.ts

@@ -60,6 +60,14 @@ export type GenerateServiceProps = {
         namespace: string;
         functionName: string;
     }) => string);
+    /**
+     * 是否生成 react-query 配置
+     */
+    isGenReactQuery?: boolean;
+    /**
+     * 是否生成 JavaScript, 不生成 TypeScript
+     */
+    isGenJavaScript?: boolean;
     /**
      * 是否生成 type 对应的label, 默认: false
      */

package/dist/index.js

@@ -28,7 +28,7 @@ function generateService(_a) {
                     ? [/.*/g]
                     : null, excludeTags: excludeTags
                 ? (0, lodash_1.map)(excludeTags, (item) => typeof item === 'string' ? item.toLowerCase() : item)
-                : null, requestOptionsType: '{[key: string]: unknown}', namespace: 'API', nullable: false, isCamelCase: true, isDisplayTypeLabel: false, isGenJsonSchemas: false, isOnlyGenTypeScriptType: false }, rest), openAPI);
+                : null, requestOptionsType: '{[key: string]: unknown}', namespace: 'API', isGenReactQuery: false, isGenJavaScript: false, isDisplayTypeLabel: false, isGenJsonSchemas: false, nullable: false, isOnlyGenTypeScriptType: false, isCamelCase: true }, rest), openAPI);
         serviceGenerator.genFile();
         if (mockFolder) {
             (0, mockGenarator_1.mockGenerator)({

package/dist/util.js

@@ -20,7 +20,7 @@ const getImportStatement = (requestLibPath) => {
         }
         return `import request from '${requestLibPath}';`;
     }
-    return `import request from 'axios';`;
+    return `import { request } from 'axios';`;
 };
 exports.getImportStatement = getImportStatement;
 function getSchema(schemaPath, authorization) {
@@ -140,29 +140,31 @@ function translateChineseModuleNodeToEnglish(openAPI) {
             });
             void Promise.all((0, lodash_1.map)((0, lodash_1.uniq)(tags), (tagName) => {
                 return new Promise((resolve) => {
-                    void (0, bing_translate_api_1.translate)(tagName, null, 'en')
-                        .then((translateRes) => {
-                        const text = (0, lodash_1.camelCase)(translateRes === null || translateRes === void 0 ? void 0 : translateRes.translation);
-                        if (text) {
-                            translateMap[tagName] = text;
-                            resolve(text);
-                        }
-                    })
-                        .catch(() => {
+                    if (tagName && /[\u3220-\uFA29]/.test(tagName)) {
+                        void (0, bing_translate_api_1.translate)(tagName, null, 'en')
+                            .then((translateRes) => {
+                            const text = (0, lodash_1.camelCase)(translateRes === null || translateRes === void 0 ? void 0 : translateRes.translation);
+                            if (text) {
+                                translateMap[tagName] = text;
+                                resolve(text);
+                            }
+                        })
+                            .catch(() => {
+                            resolve(tagName);
+                        });
+                    }
+                    else {
                         resolve(tagName);
-                    });
+                    }
                 });
             }))
                 .then(() => {
-                (0, lodash_1.map)(operations, (operation) => {
-                    var _a;
-                    const tagName = (_a = operation.tags) === null || _a === void 0 ? void 0 : _a[0];
-                    if (tagName && /[\u3220-\uFA29]/.test(tagName)) {
-                        operation.tags = [
-                            translateMap[tagName],
-                            ...operation.tags.slice(1),
-                        ];
-                    }
+                (0, lodash_1.forEach)(operations, (operation) => {
+                    (0, lodash_1.forEach)(operation.tags, (tagName, index) => {
+                        if (translateMap[tagName]) {
+                            operation.tags[index] = translateMap[tagName];
+                        }
+                    });
                 });
                 resolve(true);
             })

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "openapi-ts-request",
-  "version": "0.13.4",
-  "description": "Swagger2/OpenAPI3 to TypeScript, request client, request mock service, enum, type field label, JSON Schemas",
+  "version": "1.0.0",
+  "description": "Swagger2/OpenAPI3/Apifox to TypeScript/JavaScript, request client(support any client), request mock service, enum and enum translation, react-query, type field label, JSON Schemas",
   "engines": {
     "node": ">=18.0.0",
     "pnpm": ">=9"
@@ -51,6 +51,7 @@
     "@changesets/cli": "^2.27.6",
     "@commitlint/cli": "^19.2.1",
     "@commitlint/config-conventional": "^19.2.2",
+    "@tanstack/react-query": "^5.62.10",
     "@types/js-yaml": "^4.0.9",
     "@types/lodash": "^4.17.5",
     "@types/memoizee": "^0.4.11",
@@ -63,21 +64,25 @@
     "@typescript-eslint/parser": "^7.9.0",
     "eslint": "^8.57.1",
     "husky": "^9.0.11",
-    "lint-staged": "^15.2.5",
+    "lint-staged": "^15.3.0",
     "openapi-types": "^12.1.3",
     "ts-node": "^10.9.2",
     "typescript": "5.7.2"
   },
   "keywords": [
     "openapi",
-    "openapi3",
     "swagger",
-    "openapi to ts",
-    "openapi to request client",
-    "openapi to axios client",
-    "openapi to fetch client",
-    "openapi to uni request client",
-    "openapi to JSON Schemas"
+    "openapi-ts",
+    "swagger-ts",
+    "openapi-typescript",
+    "swagger-typescript",
+    "openapi-react-query",
+    "openapi-fetch",
+    "openapi-axios",
+    "openapi-uniapp",
+    "openapi-taro",
+    "openapi-node-fetch",
+    "openapi-JSON-Schemas"
   ],
   "scripts": {
     "start": "tsc -w",

package/templates/reactQuery.njk

@@ -0,0 +1,112 @@
+{% if genType === "ts" %}
+  /* eslint-disable */
+  // @ts-ignore
+{% endif -%}
+import { queryOptions, useMutation } from '@tanstack/react-query';
+{%- if genType === "ts" %}
+  import type { DefaultError } from '@tanstack/react-query';
+{% endif %}
+
+import * as apis from './{{ className }}';
+{%- if genType === "ts" %}
+  import * as {{ namespace }} from './{{ interfaceFileName }}';
+{% endif %}
+
+{% for api in list %}
+  /** {{ api.desc if api.desc else '此处后端没有提供注释' }} {{ api.method | upper }} {{ api.pathInComment | safe }}{{ ' ' if api.apifoxRunLink else '' }}{{ api.apifoxRunLink }} */
+  {%- if api.method | lower === "get" %}
+    export function {{ api.functionName }}QueryOptions(options
+    {%- if genType === "ts" -%}
+      : {
+      {%- if api.params and api.hasParams %}
+        // 叠加生成的Param类型 (非body参数openapi默认没有生成对象)
+        params
+        : {{ namespace }}.{{ api.typeName }}
+        {# header 入参 -#}
+        {% if api.params.header -%}
+          & { // header
+          {% for param in api.params.header -%}
+            {% if param.description -%}
+              /** {{ param.description }} */
+            {% endif -%}
+            '{{ param.name }}'
+            {{- "?" if not param.required }}
+            {{- (": " + param.type + ";") | safe }}
+          {% endfor -%}
+          }
+        {%- endif -%}
+        {%- if api.hasParams -%}
+          {{ ";" if api.body or api.file}}
+        {%- endif -%}
+      {%- endif -%}
+
+      {%- if api.body -%}
+        body: 
+        {% if api.body.propertiesList %}{
+          {%- for prop in api.body.propertiesList %}
+            {% if prop.schema.description -%}
+            /** {{ prop.schema.description }} */
+            {% endif -%}
+            '{{ prop.key }}'{{ "?" if not prop.schema.required }}: {{ prop.schema.type }},
+          {%- endfor %}
+        }
+        {%- else -%}
+          {{ api.body.type }}
+        {%- endif -%}
+        {{ ";" if api.file }}
+      {%- endif %}
+
+      {%- if api.file -%}
+        {%- for file in api.file -%}
+          {{file.title | safe}}
+          {{- "?" if not api.file.required -}}
+          : File {{ "[]" if file.multiple }}
+          {{";" if not loop.last }}
+        {%- endfor -%}
+      {%- endif -%}
+        {{ ";" if api.body or api.hasParams or api.file }}
+        options?: {{ requestOptionsType }}
+      }
+    {%- endif -%}
+    ) {
+      return queryOptions({
+        queryFn: async ({ queryKey }) => {
+          return apis.{{ api.functionName }}(queryKey[1]{{ " as typeof options" if genType === "ts" }});
+        },
+        queryKey: ['{{ api.functionName }}', options],
+      });
+    }
+  {%- else %}
+    export function use{{ api.functionName | capitalizeFirst }}Mutation(options
+      {%- if genType === "ts" -%}
+        ?: {
+          onSuccess?: (value?: {{ api.response.type }}) => void;
+          onError?: (error?: DefaultError) => void;
+        }
+      {%- endif %}
+    ) {
+      const { onSuccess, onError } = options || {};
+
+      const response = useMutation({
+        mutationFn: apis.{{ api.functionName }},
+        onSuccess(data{{ (": " + api.response.type) | safe if genType === "ts" }}) {
+          {% if genType === "ts" %}
+            onSuccess?.(data);
+          {% else %}
+            onSuccess && onSuccess(data);
+          {% endif %}
+        },
+        onError(error) {
+          {% if genType === "ts" %}
+            onError?.(error);
+          {% else %}
+            onError && onError(error);
+          {% endif %}
+        }
+      })
+
+      return response;
+    }
+  {%- endif %}
+
+{% endfor %}

package/templates/serviceController.njk

@@ -1,168 +1,173 @@
-/* eslint-disable */
-// @ts-ignore
-import * as {{ namespace }} from './{{ interfaceFileName }}';
+{% if genType === "ts" %}
+  /* eslint-disable */
+  // @ts-ignore
+{% endif -%}
 {{ requestImportStatement }}
+{% if genType === "ts" %}
+  import * as {{ namespace }} from './{{ interfaceFileName }}';
+{% endif %}
 
 {% for api in list -%}
-/** {{ api.desc if api.desc else '此处后端没有提供注释' }} {{ api.method | upper }} {{ api.pathInComment | safe }}{{ ' ' if api.apifoxRunLink else '' }}{{ api.apifoxRunLink | safe }} */
-export async function {{ api.functionName }}(
-{%- if api.params and api.hasParams %}
-  // 叠加生成的Param类型 (非body参数openapi默认没有生成对象)
-  params
-  {%- if genType === "ts" -%}
-  : {{namespace}}.{{api.typeName}}
-    {# header 入参 -#}
-    {% if api.params.header -%}
-    & { // header
-    {% for param in api.params.header -%}
-    {% if param.description -%}
-    /** {{ param.description }} */
-    {% endif -%}
-      '{{ param.name }}'
-      {{- "?" if not param.required }}
-      {{- (": " + param.type + ";") | safe }}
-    {% endfor -%}
-    }
+  /** {{ api.desc if api.desc else '此处后端没有提供注释' }} {{ api.method | upper }} {{ api.pathInComment | safe }}{{ ' ' if api.apifoxRunLink else '' }}{{ api.apifoxRunLink }} */
+  export async function {{ api.functionName }}({
+    {%- if api.params and api.hasParams %}
+      params
+      {%- if api.hasParams -%}
+        {{ "," if api.body or api.file }}
+      {%- endif -%}
     {%- endif -%}
-  {%- endif -%}
-  {%- if api.hasParams -%}
-  {{ "," if api.body or api.file}}
-  {%- endif -%}
-{%- endif -%}
-
-
-
-{%- if api.body -%}
-  body
-  {%- if genType === "ts" -%}
-
-  : {% if api.body.propertiesList %}{
-    {%- for prop in api.body.propertiesList %}
-    {% if prop.schema.description -%}
-    /** {{ prop.schema.description }} */
-    {% endif -%}
-    '{{ prop.key }}'{{ "?" if not prop.schema.required }}: {{ prop.schema.type }},
-    {%- endfor %}
+    {%- if api.body -%}
+      body
+      {{ "," if api.file }}
+    {%- endif %}
+    {%- if api.file -%}
+      {%- for file in api.file -%}
+        {{ file.title | safe }}
+        {{ "," if not loop.last }}
+      {%- endfor -%}
+    {%- endif -%}
+    {{ "," if api.body or api.hasParams or api.file }}
+    options
   }
-  {%- else -%}
-  {{ api.body.type }}
-  {%- endif -%}
-  
-  {%- endif -%}
-  {{ "," if api.file }}
-{%- endif %}
-
-
-
-{%- if api.file -%}
-{%- for file in api.file -%}
-{{file.title | safe}}
-{%- if genType === "ts" -%}
-{{- "?" if not api.file.required -}}
-: File {{ "[]" if file.multiple }}
-{%- endif -%}
-{{"," if not loop.last }}
-{%- endfor -%}
-{%- endif -%}
-
-
-
-{{ "," if api.body or api.hasParams or api.file }}
-  options {{ ("?: " + requestOptionsType) if genType === "ts" }}
-) {
-  {% if api.params and api.params.path -%}
-  const { {% for param in api.params.path %}'{{ param.name }}': {{ param.alias }}, {% endfor %}
-  {% if api.params.path -%}
-  ...queryParams
-  {% endif -%}
-  } = params;
-  {% endif -%}
-
-
-
-  {% if api.hasFormData -%}
-  const formData = new FormData();
+  {%- if genType === "ts" -%}
+    : {
+      {%- if api.params and api.hasParams %}
+        // 叠加生成的Param类型 (非body参数openapi默认没有生成对象)
+        params: {{ namespace }}.{{ api.typeName }}
+        {# header 入参 -#}
+        {% if api.params.header -%}
+          & { // header
+          {% for param in api.params.header -%}
+            {% if param.description -%}
+              /** {{ param.description }} */
+            {% endif -%}
+            '{{ param.name }}'
+            {{- "?" if not param.required }}
+            {{- (": " + param.type + ";") | safe }}
+          {% endfor -%}
+          }
+        {%- endif -%}
+        {%- if api.hasParams -%}
+          {{ ";" if api.body or api.file }}
+        {%- endif -%}
+      {%- endif -%}
+
+      {%- if api.body -%}
+        body: 
+        {% if api.body.propertiesList %}
+          {
+          {%- for prop in api.body.propertiesList %}
+            {% if prop.schema.description -%}
+              /** {{ prop.schema.description }} */
+            {% endif -%}
+            '{{ prop.key }}'{{ "?" if not prop.schema.required }}: {{ prop.schema.type }},
+          {%- endfor %}
+          }
+        {%- else -%}
+          {{ api.body.type }}
+        {%- endif -%}
+        {{ ";" if api.file }}
+      {%- endif %}
 
-  {% if api.file -%}
-  {% for file in api.file %}
-  if({{file.title | safe}}){
-  {% if file.multiple %}
-  {{file.title | safe}}.forEach(f => formData.append('{{file.title | safe}}', f || ''));
-  {% else %}
-  formData.append('{{file.title | safe}}', {{file.title | safe}})
-  {% endif %}
-  }
-  {% endfor %}
+      {%- if api.file -%}
+        {%- for file in api.file -%}
+          {{ file.title | safe }}
+          {{- "?" if not api.file.required -}}
+          : File {{ "[]" if file.multiple }}
+          {{ ";" if not loop.last }}
+        {%- endfor -%}
+      {%- endif -%}
+      {{ ";" if api.body or api.hasParams or api.file }}
+      options?: {{ requestOptionsType }}
+    }
   {%- endif -%}
-
-  {% if api.body %}
-  Object.keys(body).forEach(ele => {
-    {% if genType === "ts" %}
-    const item = (body as { [key: string]: any })[ele];
-    {% else %}
-    const item = body[ele];
+  ) 
+  {
+    {% if api.params and api.params.path %}
+      const { {% for param in api.params.path %}'{{ param.name }}': {{ param.alias }}, {% endfor %}
+      {% if api.params.path -%}
+        ...queryParams
+      {% endif -%}
+      } = params;
     {% endif %}
-    if (item !== undefined && item !== null) {
-      {% if genType === "ts" %}
-      if (typeof item === 'object' && !(item instanceof File)) {
-        if (item instanceof Array) {
-          item.forEach((f) => formData.append(ele, f || ''));
-        } else {
-          formData.append(ele, JSON.stringify(item));
-        }
-      } else {
-        formData.append(ele, item);
-      }
-      {% else %}
-      formData.append(ele, typeof item === 'object' ? JSON.stringify(item) : item);
+    {%- if api.hasFormData -%}
+      const formData = new FormData();
+
+      {% if api.file -%}
+        {% for file in api.file %}
+          if({{ file.title | safe }}) {
+          {% if file.multiple %}
+            {{ file.title | safe }}.forEach(f => formData.append('{{ file.title | safe }}', f || ''));
+          {% else %}
+            formData.append('{{ file.title | safe }}', {{ file.title | safe }})
+          {% endif %}
+          }
+        {% endfor %}
+      {%- endif -%}
+
+      {% if api.body %}
+        Object.keys(body).forEach(ele => {
+        {% if genType === "ts" %}
+          const item = (body as { [key: string]: any })[ele];
+        {% else %}
+          const item = body[ele];
+        {% endif %}
+          if (item !== undefined && item !== null) {
+            {% if genType === "ts" %}
+              if (typeof item === 'object' && !(item instanceof File)) {
+                if (item instanceof Array) {
+                  item.forEach((f) => formData.append(ele, f || ''));
+                } else {
+                  formData.append(ele, JSON.stringify(item));
+                }
+              } else {
+                formData.append(ele, item);
+              }
+            {% else %}
+              formData.append(ele, typeof item === 'object' ? JSON.stringify(item) : item);
+            {% endif %}
+          }
+        });
       {% endif %}
-    }
-  });
-  {% endif %}
-  {% endif -%}
-
-
-  
-  {% if api.hasPathVariables or api.hasApiPrefix -%}
-  return request{{ ("<" + api.response.type + ">") | safe if genType === "ts" }}(`{{ api.path | safe }}`, {
-  {% else -%}
-  return request{{ ("<" + api.response.type + ">") | safe if genType === "ts" }}('{{ api.path }}', {
-  {% endif -%}
-    method: '{{ api.method | upper }}',
+    {% endif %}
 
-    {%- if api.hasHeader and api.body.mediaType %}
-    headers: {
-      {%- if api.body.mediaType %}
-      'Content-Type': '{{ api.body.mediaType | safe }}',
+    {% if api.hasPathVariables or api.hasApiPrefix -%}
+      return request{{ ("<" + api.response.type + ">") | safe if genType === "ts" }}(`{{ api.path | safe }}`, {
+    {% else -%}
+      return request{{ ("<" + api.response.type + ">") | safe if genType === "ts" }}('{{ api.path }}', {
+    {% endif -%}
+      method: '{{ api.method | upper }}',
+      {%- if api.hasHeader and api.body.mediaType %}
+        headers: {
+          {%- if api.body.mediaType %}
+          'Content-Type': '{{ api.body.mediaType | safe }}',
+          {%- endif %}
+        },
       {%- endif %}
-    },
-    {%- endif %}
-
-    {%- if api.params and api.hasParams %}
-    params: {
-      {%- for query in api.params.query %}
-        {% if query.schema.default -%}
-          // {{query.name | safe}} has a default value: {{ query.schema.default | safe }}
-          '{{query.name | safe}}': '{{query.schema.default | safe}}',
-        {%- endif -%}
-      {%- endfor -%}
-      ...{{ 'queryParams' if api.params and api.params.path else 'params' }},
-      {%- for query in api.params.query %}
-        {%- if query.isComplexType %}
-          '{{query.name | safe}}': undefined,
-          ...{{ 'queryParams' if api.params and api.params.path else 'params' }}['{{query.name | safe}}'],
-        {%- endif %}
-      {%- endfor -%}
-    },
-    {%- endif %}
-
-    {%- if api.hasFormData %}
-    data: formData,
-    {%- elseif api.body %}
-    data: body,
-    {%- endif %}
-    ...(options || {{api.options | dump}}),
-  });
-}
+      {%- if api.params and api.hasParams %}
+        params: {
+          {%- for query in api.params.query %}
+            {% if query.schema.default -%}
+              // {{ query.name | safe }} has a default value: {{ query.schema.default | safe }}
+              '{{ query.name | safe }}': '{{query.schema.default | safe}}',
+            {%- endif -%}
+          {%- endfor -%}
+          ...{{ 'queryParams' if api.params and api.params.path else 'params' }},
+          {%- for query in api.params.query %}
+            {%- if query.isComplexType %}
+              '{{ query.name | safe }}': undefined,
+              ...{{ 'queryParams' if api.params and api.params.path else 'params' }}['{{ query.name | safe }}'],
+            {%- endif %}
+          {%- endfor -%}
+        },
+      {%- endif %}
+      {%- if api.hasFormData %}
+        data: formData,
+      {%- elseif api.body %}
+        data: body,
+      {%- endif %}
+      ...(options || {{ api.options | dump }}),
+    });
+  }
 
 {% endfor -%}

package/templates/serviceIndex.njk

@@ -1,15 +1,21 @@
-/* eslint-disable */
-// @ts-ignore
-export * from './{{ interfaceFileName }}';
-{%- if isDisplayEnumLabel %}
-export * from './{{ displayEnumLabelFileName }}';
-{%- endif %}
-{%- if isDisplayTypeLabel %}
-export * from './{{ displayTypeLabelFileName }}';
-{%- endif %}
+{% if genType === "ts" %}
+  /* eslint-disable */
+  // @ts-ignore
+  export * from './{{ interfaceFileName }}';
+  {%- if isDisplayEnumLabel %}
+    export * from './{{ displayEnumLabelFileName }}';
+  {% endif -%}
+  {%- if isDisplayTypeLabel %}
+    export * from './{{ displayTypeLabelFileName }}';
+  {% endif -%}
+{% endif %}
 {%- if isGenJsonSchemas %}
-export * from './{{ schemaFileName }}';
+  export * from './{{ schemaFileName }}';
 {%- endif %}
+
 {% for api in list -%}
-export * from './{{ api.fileName }}';
-{% endfor -%}
+  export * from './{{ api.fileName }}';
+  {%- if isGenReactQuery -%}
+    export * from './{{ api.fileName }}.{{ reactQueryFileName }}';
+  {%- endif -%}
+{%- endfor -%}