openapi-ts-request 1.9.0 → 1.9.2

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;
 ```
@@ -194,7 +190,7 @@ $ openapi --help
     -f, --full <boolean>                full replacement (default: true)
     --enableLogging <boolean>           open the log (default: false)
     --priorityRule <string>             priority rule, include/exclude/both (default: "include")
-    --filterCaseInsensitive <boolean>   whether to perform a case-insensitive match with includeTags, includePaths, excludeTags, excludePaths filters
+    --filterCaseInsensitive <boolean>   whether to perform a case-insensitive match with includeTags, includePaths, excludeTags, excludePaths filters (default: false)
     --includeTags <(string|RegExp)[]>   generate code from include tags
     --includePaths <(string|RegExp)[]>  generate code from include paths
     --excludeTags <(string|RegExp)[]>   generate code from exclude tags
@@ -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

package/dist/bin/openapi.js

@@ -21,8 +21,7 @@ const params = commander_1.program
     .option('--requestLibPath <string>', 'custom request lib path, for example: "@/request", "node-fetch" (default: "axios")')
     .option('-f, --full <boolean>', 'full replacement', true)
     .option('--enableLogging <boolean>', 'open the log', false)
-    .option('--filterCaseInsensitive <boolean>', 'whether to perform a case-insensitive match with includeTags, includePaths, excludeTags, excludePaths filters', false)
-    .option('--includeTags <(string|RegExp)[]>', 'generate code from include tags')
+    .option('--priorityRule <string>', 'priority rule, include/exclude/both (default: "include")')
     .option('--filterCaseInsensitive <boolean>', 'whether to perform a case-insensitive match with includeTags, includePaths, excludeTags, excludePaths filters', false)
     .option('--includeTags <(string|RegExp)[]>', 'generate code from include tags')
     .option('--includePaths <(string|RegExp)[]>', 'generate code from include paths')

package/dist/generator/serviceGenarator.js

@@ -391,7 +391,7 @@ class ServiceGenerator {
             // 暂不支持变量, path 需要普通前缀请使用例如: apiPrefix: "`api`", path 需要变量前缀请使用例如: apiPrefix: "api"
             !api.path.includes('${'))
                 .map((api) => {
-                var _a, _b, _c, _d, _e, _f;
+                var _a, _b, _c, _d, _e, _f, _g, _h;
                 const newApi = api;
                 try {
                     const params = this.getParamsTP(newApi.parameters, newApi.path) || {};
@@ -422,9 +422,13 @@ class ServiceGenerator {
                     }
                     if (response === null || response === void 0 ? void 0 : response.isAnonymous) {
                         const responseName = (0, lodash_1.upperFirst)(`${functionName}Response`);
+                        // 使用正则表达式移除 response?.type 中包含 this.config.namespace 的部分，isAnonymous模式不需要 this.config.namespace 前缀
+                        const cleanType = ((_b = response === null || response === void 0 ? void 0 : response.type) === null || _b === void 0 ? void 0 : _b.includes(`${this.config.namespace}.`))
+                            ? (_c = response === null || response === void 0 ? void 0 : response.type) === null || _c === void 0 ? void 0 : _c.replace(new RegExp(`${this.config.namespace}\\.`, 'g'), '')
+                            : (response === null || response === void 0 ? void 0 : response.type) || '';
                         this.interfaceTPConfigs.push({
                             typeName: responseName,
-                            type: response === null || response === void 0 ? void 0 : response.type,
+                            type: cleanType,
                             isEnum: false,
                             props: [],
                         });
@@ -494,13 +498,13 @@ class ServiceGenerator {
                             : [
                                 newApi.summary,
                                 newApi.description,
-                                ((_c = (_b = newApi.responses) === null || _b === void 0 ? void 0 : _b.default) === null || _c === void 0 ? void 0 : _c.description)
-                                    ? `返回值: ${((_d = newApi.responses) === null || _d === void 0 ? void 0 : _d.default).description}`
+                                ((_e = (_d = newApi.responses) === null || _d === void 0 ? void 0 : _d.default) === null || _e === void 0 ? void 0 : _e.description)
+                                    ? `返回值: ${((_f = newApi.responses) === null || _f === void 0 ? void 0 : _f.default).description}`
                                     : '',
                             ]
                                 .filter((s) => s)
                                 .join(' ')
-                                .replace(config_2.lineBreakReg, ''), hasHeader: !!(params === null || params === void 0 ? void 0 : params.header) || !!(body === null || body === void 0 ? void 0 : body.mediaType), params: finalParams, hasParams: Boolean((0, lodash_1.keys)(finalParams).length), options: ((_f = (_e = this.config.hook) === null || _e === void 0 ? void 0 : _e.customOptionsDefaultValue) === null || _f === void 0 ? void 0 : _f.call(_e, newApi)) || {}, body,
+                                .replace(config_2.lineBreakReg, ''), hasHeader: !!(params === null || params === void 0 ? void 0 : params.header) || !!(body === null || body === void 0 ? void 0 : body.mediaType), params: finalParams, hasParams: Boolean((0, lodash_1.keys)(finalParams).length), options: ((_h = (_g = this.config.hook) === null || _g === void 0 ? void 0 : _g.customOptionsDefaultValue) === null || _h === void 0 ? void 0 : _h.call(_g, newApi)) || {}, body,
                         file, hasFormData: formData, response });
                 }
                 catch (error) {
@@ -734,15 +738,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;
         }
@@ -752,7 +760,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];
@@ -845,12 +862,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

@@ -143,6 +143,11 @@ export type GenerateServiceProps = {
      * 多网关唯一标识
      */
     uniqueKey?: string;
+    /**
+     * 自定义二进制媒体类型列表
+     * 默认包含: ['application/octet-stream', 'application/pdf', 'image/*', 'video/*', 'audio/*']
+     */
+    binaryMediaTypes?: string[];
     /**
      * 自定义 hook
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi-ts-request",
-  "version": "1.9.0",
+  "version": "1.9.2",
   "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 %}