openapi-ts-request 1.8.4 → 1.9.1

package/README.md

@@ -1,5 +1,3 @@
-<!-- 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)
@@ -50,8 +48,6 @@ pnpm i openapi-ts-request -D
 import type { GenerateServiceProps } from 'openapi-ts-request';
 
 export default {
-  // schemaPath: './openapi.json', // 本地openapi文件
-  // serversPath: './src/apis', // 接口存放路径
   schemaPath: 'http://petstore.swagger.io/v2/swagger.json',
 } as GenerateServiceProps;
 ```
@@ -254,6 +250,7 @@ openapi --i ./spec.json --o ./apis
 | isOnlyGenTypeScriptType | 否 | boolean | false | 仅生成 typescript 类型 |
 | isCamelCase | 否 | boolean | true | 小驼峰命名文件和请求函数 |
 | isSupportParseEnumDesc | 否 | boolean | false | 解析枚举描述生成枚举标签，格式参考：`系统用户角色:User(普通用户)=0,Agent(经纪人)=1,Admin(管理员)=2` |
+| binaryMediaTypes | 否 | string[] | - | 自定义二进制媒体类型列表，默认包含：['application/octet-stream', 'application/pdf', 'image/*', 'video/*', 'audio/*'] |
 | hook | 否 | [Custom Hook](#Custom-Hook) | - | 自定义 hook |
 
 ## 自定义 Hook
@@ -267,6 +264,7 @@ 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> _返回为空，则使用默认的方法获取_ |
 | customTemplates | {<br>[TypescriptFileType.serviceController]?: <T, U>(item: T, context: U) => string;<br>} | 自定义模板，详情请看源码 |
+| customRenderTemplateData | {<br>[TypescriptFileType]?: (list: any[], context: {fileName: string, params: Record<string, unknown>}) => any[]<br>} | 自定义文件生成时的 list 参数处理，支持对不同文件类型进行精细化控制 |
 
 ## Apifox-Config
 

package/dist/generator/serviceGenarator.js

@@ -531,15 +531,75 @@ class ServiceGenerator {
             .filter((item) => { var _a; return !!((_a = item === null || item === void 0 ? void 0 : item.list) === null || _a === void 0 ? void 0 : _a.length); });
     }
     genFileFromTemplate(fileName, type, params) {
+        var _a;
         try {
             const template = this.getTemplate(type);
+            // 应用 customRenderTemplateData hook (如果存在)
+            let processedParams = Object.assign({}, params);
+            const customListHooks = (_a = this.config.hook) === null || _a === void 0 ? void 0 : _a.customRenderTemplateData;
+            if (customListHooks && params.list) {
+                try {
+                    const context = {
+                        fileName,
+                        params: processedParams,
+                    };
+                    let processedList = params.list;
+                    // 根据不同的文件类型调用相应的 hook 函数
+                    switch (type) {
+                        case config_2.TypescriptFileType.serviceController:
+                            if (customListHooks.serviceController) {
+                                processedList = customListHooks.serviceController(params.list, context);
+                            }
+                            break;
+                        case config_2.TypescriptFileType.reactQuery:
+                            if (customListHooks.reactQuery) {
+                                processedList = customListHooks.reactQuery(params.list, context);
+                            }
+                            break;
+                        case config_2.TypescriptFileType.interface:
+                            if (customListHooks.interface) {
+                                processedList = customListHooks.interface(params.list, context);
+                            }
+                            break;
+                        case config_2.TypescriptFileType.displayEnumLabel:
+                            if (customListHooks.displayEnumLabel) {
+                                processedList = customListHooks.displayEnumLabel(params.list, context);
+                            }
+                            break;
+                        case config_2.TypescriptFileType.displayTypeLabel:
+                            if (customListHooks.displayTypeLabel) {
+                                processedList = customListHooks.displayTypeLabel(params.list, context);
+                            }
+                            break;
+                        case config_2.TypescriptFileType.schema:
+                            if (customListHooks.schema) {
+                                processedList = customListHooks.schema(params.list, context);
+                            }
+                            break;
+                        case config_2.TypescriptFileType.serviceIndex:
+                            if (customListHooks.serviceIndex) {
+                                processedList = customListHooks.serviceIndex(params.list, context);
+                            }
+                            break;
+                    }
+                    if (processedList !== params.list) {
+                        processedParams = Object.assign(Object.assign({}, processedParams), { list: processedList });
+                        this.log(`customRenderTemplateData hook applied for ${type}: ${fileName}`);
+                    }
+                }
+                catch (error) {
+                    console.error(`[GenSDK] customRenderTemplateData hook error for ${type}:`, error);
+                    this.log(`customRenderTemplateData hook failed for ${type}, using original list`);
+                    // 发生错误时使用原始参数继续执行
+                }
+            }
             // 设置输出不转义
             const env = nunjucks_1.default.configure({
                 autoescape: false,
             });
             env.addFilter('capitalizeFirst', util_2.capitalizeFirstLetter);
             const destPath = (0, path_1.join)(this.config.serversPath, fileName);
-            const destCode = nunjucks_1.default.renderString(template, Object.assign({ disableTypeCheck: false }, params));
+            const destCode = nunjucks_1.default.renderString(template, Object.assign({ disableTypeCheck: false }, processedParams));
             let mergerProps = {};
             if ((0, fs_1.existsSync)(destPath)) {
                 mergerProps = {
@@ -674,15 +734,19 @@ class ServiceGenerator {
             mediaType: '*/*',
             type: 'unknown',
             isAnonymous: false,
+            responseType: undefined,
         };
         if (!response) {
             return defaultResponse;
         }
         const resContent = response.content;
         const resContentMediaTypes = (0, lodash_1.keys)(resContent);
+        // 检测二进制流媒体类型
+        const binaryMediaTypes = (0, util_2.getBinaryMediaTypes)(this.config.binaryMediaTypes);
+        const binaryMediaType = resContentMediaTypes.find((mediaType) => (0, util_2.isBinaryMediaType)(mediaType, binaryMediaTypes));
         const mediaType = resContentMediaTypes.includes('application/json')
             ? 'application/json'
-            : resContentMediaTypes[0]; // 优先使用 application/json
+            : binaryMediaType || resContentMediaTypes[0]; // 优先使用 application/json，然后是二进制类型
         if (!(0, lodash_1.isObject)(resContent) || !mediaType) {
             return defaultResponse;
         }
@@ -692,7 +756,16 @@ class ServiceGenerator {
             mediaType,
             type: 'unknown',
             isAnonymous: false,
+            responseType: undefined,
         };
+        // 如果是二进制媒体类型，直接返回二进制类型
+        if ((0, util_2.isBinaryMediaType)(mediaType, binaryMediaTypes)) {
+            const binaryType = (0, util_2.getBinaryResponseType)();
+            responseSchema.type = binaryType;
+            // 自动为二进制响应添加 responseType 配置
+            responseSchema.responseType = (0, util_2.getAxiosResponseType)(binaryType);
+            return responseSchema;
+        }
         if ((0, util_2.isReferenceObject)(schema)) {
             const refName = (0, util_2.getLastRefName)(schema.$ref);
             const childrenSchema = components.schemas[refName];
@@ -785,12 +858,19 @@ class ServiceGenerator {
         }
         const resContent = response.content;
         const resContentMediaTypes = (0, lodash_1.keys)(resContent);
+        // 检测二进制流媒体类型
+        const binaryMediaTypes = (0, util_2.getBinaryMediaTypes)(this.config.binaryMediaTypes);
+        const binaryMediaType = resContentMediaTypes.find((mediaType) => (0, util_2.isBinaryMediaType)(mediaType, binaryMediaTypes));
         const mediaType = resContentMediaTypes.includes('application/json')
             ? 'application/json'
-            : resContentMediaTypes[0];
+            : binaryMediaType || resContentMediaTypes[0];
         if (!(0, lodash_1.isObject)(resContent) || !mediaType) {
             return 'unknown';
         }
+        // 如果是二进制媒体类型，直接返回二进制类型
+        if ((0, util_2.isBinaryMediaType)(mediaType, binaryMediaTypes)) {
+            return (0, util_2.getBinaryResponseType)();
+        }
         let schema = (resContent[mediaType].schema ||
             config_2.DEFAULT_SCHEMA);
         if ((0, util_2.isReferenceObject)(schema)) {

package/dist/generator/util.d.ts

@@ -23,3 +23,30 @@ export declare function isAllNumeric(arr: any): boolean;
 export declare function isAllNumber(arr: any): boolean;
 export declare function capitalizeFirstLetter(str: string): string;
 export declare const parseDescriptionEnum: (description: string) => Map<number, string>;
+/**
+ * 获取默认的二进制媒体类型列表
+ */
+export declare const getDefaultBinaryMediaTypes: () => string[];
+/**
+ * 获取二进制媒体类型列表
+ * 支持配置自定义二进制媒体类型
+ * @param customBinaryTypes 自定义二进制媒体类型列表
+ */
+export declare const getBinaryMediaTypes: (customBinaryTypes?: string[]) => string[];
+/**
+ * 检测是否为二进制媒体类型
+ * @param mediaType 媒体类型
+ * @param binaryMediaTypes 二进制媒体类型列表
+ */
+export declare const isBinaryMediaType: (mediaType: string, binaryMediaTypes: string[]) => boolean;
+/**
+ * 获取二进制响应类型
+ * 默认返回 Blob，这是浏览器环境中最常用的二进制类型
+ */
+export declare const getBinaryResponseType: () => string;
+/**
+ * 获取 axios responseType 配置
+ * 根据二进制响应类型返回对应的 responseType
+ * @param binaryType 二进制类型
+ */
+export declare const getAxiosResponseType: (binaryType: string) => string;

package/dist/generator/util.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseDescriptionEnum = void 0;
+exports.getAxiosResponseType = exports.getBinaryResponseType = exports.isBinaryMediaType = exports.getBinaryMediaTypes = exports.getDefaultBinaryMediaTypes = exports.parseDescriptionEnum = void 0;
 exports.stripDot = stripDot;
 exports.resolveTypeName = resolveTypeName;
 exports.getRefName = getRefName;
@@ -408,3 +408,72 @@ const parseDescriptionEnum = (description) => {
     return enumMap;
 };
 exports.parseDescriptionEnum = parseDescriptionEnum;
+/**
+ * 获取默认的二进制媒体类型列表
+ */
+const getDefaultBinaryMediaTypes = () => {
+    return [
+        'application/octet-stream',
+        'application/pdf',
+        'application/zip',
+        'application/x-zip-compressed',
+        'image/*',
+        'video/*',
+        'audio/*',
+    ];
+};
+exports.getDefaultBinaryMediaTypes = getDefaultBinaryMediaTypes;
+/**
+ * 获取二进制媒体类型列表
+ * 支持配置自定义二进制媒体类型
+ * @param customBinaryTypes 自定义二进制媒体类型列表
+ */
+const getBinaryMediaTypes = (customBinaryTypes = []) => {
+    const defaultBinaryTypes = (0, exports.getDefaultBinaryMediaTypes)();
+    return [...defaultBinaryTypes, ...customBinaryTypes];
+};
+exports.getBinaryMediaTypes = getBinaryMediaTypes;
+/**
+ * 检测是否为二进制媒体类型
+ * @param mediaType 媒体类型
+ * @param binaryMediaTypes 二进制媒体类型列表
+ */
+const isBinaryMediaType = (mediaType, binaryMediaTypes) => {
+    return binaryMediaTypes.some((type) => {
+        if (type.endsWith('/*')) {
+            // 处理通配符类型，如 image/*, video/*
+            const prefix = type.slice(0, -1);
+            return mediaType.startsWith(prefix);
+        }
+        return mediaType === type;
+    });
+};
+exports.isBinaryMediaType = isBinaryMediaType;
+/**
+ * 获取二进制响应类型
+ * 默认返回 Blob，这是浏览器环境中最常用的二进制类型
+ */
+const getBinaryResponseType = () => {
+    return 'Blob';
+};
+exports.getBinaryResponseType = getBinaryResponseType;
+/**
+ * 获取 axios responseType 配置
+ * 根据二进制响应类型返回对应的 responseType
+ * @param binaryType 二进制类型
+ */
+const getAxiosResponseType = (binaryType) => {
+    switch (binaryType.toLowerCase()) {
+        case 'blob':
+            return 'blob';
+        case 'arraybuffer':
+            return 'arraybuffer';
+        case 'uint8array':
+            return 'arraybuffer'; // Uint8Array 需要从 ArrayBuffer 转换
+        case 'buffer':
+            return 'arraybuffer'; // Node.js Buffer 需要从 ArrayBuffer 转换
+        default:
+            return 'blob';
+    }
+};
+exports.getAxiosResponseType = getAxiosResponseType;

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import type { TypescriptFileType } from './generator/config';
-import type { APIDataType, ITypeItem } from './generator/type';
+import type { APIDataType, ControllerType, ISchemaItem, ITypeItem } from './generator/type';
 import type { ComponentsObject, IPriorityRule, IReactQueryMode, OpenAPIObject, OperationObject, ReferenceObject, SchemaObject } from './type';
 import { type GetSchemaByApifoxProps } from './type';
 export * from './generator/patchSchema';
@@ -143,6 +143,11 @@ export type GenerateServiceProps = {
      * 多网关唯一标识
      */
     uniqueKey?: string;
+    /**
+     * 自定义二进制媒体类型列表
+     * 默认包含: ['application/octet-stream', 'application/pdf', 'image/*', 'video/*', 'audio/*']
+     */
+    binaryMediaTypes?: string[];
     /**
      * 自定义 hook
      */
@@ -217,6 +222,61 @@ export type GenerateServiceProps = {
              */
             [TypescriptFileType.displayTypeLabel]?: <T, U>(types: T[], config: U) => ITypeItem[];
         };
+        /**
+         * 自定义 genFileFromTemplate 的 list 参数 hook
+         * 可以在模板渲染前对 list 参数进行自定义处理
+         */
+        customRenderTemplateData?: {
+            /**
+             * 自定义 serviceController 文件的 list 参数
+             */
+            [TypescriptFileType.serviceController]?: (list: APIDataType[], context: {
+                fileName: string;
+                params: Record<string, unknown>;
+            }) => APIDataType[];
+            /**
+             * 自定义 interface 文件的 list 参数
+             */
+            [TypescriptFileType.interface]?: (list: ITypeItem[], context: {
+                fileName: string;
+                params: Record<string, unknown>;
+            }) => ITypeItem[];
+            /**
+             * 自定义 displayEnumLabel 文件的 list 参数
+             */
+            [TypescriptFileType.displayEnumLabel]?: (list: ITypeItem[], context: {
+                fileName: string;
+                params: Record<string, unknown>;
+            }) => ITypeItem[];
+            /**
+             * 自定义 displayTypeLabel 文件的 list 参数
+             */
+            [TypescriptFileType.displayTypeLabel]?: (list: ITypeItem[], context: {
+                fileName: string;
+                params: Record<string, unknown>;
+            }) => ITypeItem[];
+            /**
+             * 自定义 schema 文件的 list 参数
+             */
+            [TypescriptFileType.schema]?: (list: ISchemaItem[], context: {
+                fileName: string;
+                params: Record<string, unknown>;
+            }) => ISchemaItem[];
+            /**
+             * 自定义 serviceIndex 文件的 list 参数
+             */
+            [TypescriptFileType.serviceIndex]?: (list: ControllerType[], context: {
+                fileName: string;
+                params: Record<string, unknown>;
+            }) => ControllerType[];
+            /**
+             * 自定义 reactQuery 文件的 list 参数
+             */
+            [TypescriptFileType.reactQuery]?: (list: APIDataType[], context: {
+                fileName: string;
+                params: Record<string, unknown>;
+            }) => APIDataType[];
+        };
     };
 };
 export declare function generateService({ requestLibPath, schemaPath, mockFolder, includeTags, excludeTags, includePaths, excludePaths, authorization, isTranslateToEnglishTag, priorityRule, timeout, reactQueryMode, apifoxConfig, ...rest }: GenerateServiceProps): Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi-ts-request",
-  "version": "1.8.4",
+  "version": "1.9.1",
   "description": "Swagger2/OpenAPI3/Apifox to TypeScript/JavaScript, request client(support any client), request mock service, enum and enum translation, react-query/vue-query, type field label, JSON Schemas",
   "engines": {
     "node": ">=18.0.0",
@@ -70,7 +70,7 @@
     "openapi-types": "^12.1.3",
     "sanitize-filename": "^1.6.3",
     "ts-node": "^10.9.2",
-    "typescript": "5.9.2",
+    "typescript": "5.9.3",
     "vitest": "^2.1.9"
   },
   "keywords": [

package/templates/serviceController.njk

@@ -128,6 +128,9 @@
         return request{{ ("<" + api.response.type + ">") | safe if genType === "ts" }}('{{ api.path }}', {
       {% endif -%}
         method: '{{ api.method | upper }}',
+        {%- if api.response.responseType %}
+        responseType: '{{ api.response.responseType }}',
+        {%- endif %}
         {%- if api.hasHeader and api.body.mediaType %}
           headers: {
             {%- if api.body.mediaType %}