openapi-ts-request 1.6.7 → 1.7.0

package/dist/generator/serviceGenarator.d.ts

@@ -21,6 +21,33 @@ export default class ServiceGenerator {
     private getFileTP;
     private resolveFileTP;
     private getResponseTP;
+    /**
+     * 生成多状态码响应类型定义
+     * 将 OpenAPI 的 responses 对象转换为 TypeScript 类型定义
+     * 例如：{ 200: ResponseType, 400: unknown, 404: unknown }
+     *
+     * @param responses OpenAPI 响应对象
+     * @param functionName 函数名称，用于生成主响应类型名称
+     * @returns 多状态码响应类型定义字符串，如果没有响应则返回 null
+     */
+    private getResponsesType;
+    /**
+     * 解析响应条目，提取每个状态码对应的类型和描述信息
+     *
+     * @param responses OpenAPI 响应对象
+     * @param components OpenAPI 组件对象，用于解析引用类型
+     * @returns 响应条目数组，包含状态码、类型和描述
+     */
+    private parseResponseEntries;
+    /**
+     * 从响应内容中提取 TypeScript 类型
+     * 处理不同的媒体类型和 schema 类型
+     *
+     * @param response 响应对象
+     * @param components OpenAPI 组件对象
+     * @returns TypeScript 类型字符串
+     */
+    private getResponseTypeFromContent;
     private getParamsTP;
     private resolveObject;
     private resolveArray;

package/dist/generator/serviceGenarator.js

@@ -424,6 +424,16 @@ class ServiceGenerator {
                         });
                         response.type = `${this.config.namespace}.${responseName}`;
                     }
+                    const responsesType = this.getResponsesType(newApi.responses, functionName);
+                    // 如果有多个响应类型，生成对应的类型定义
+                    if (responsesType) {
+                        this.interfaceTPConfigs.push({
+                            typeName: (0, lodash_1.upperFirst)(`${functionName}Responses`),
+                            type: responsesType,
+                            isEnum: false,
+                            props: [],
+                        });
+                    }
                     let formattedPath = newApi.path.replace(/:([^/]*)|{([^}]*)}/gi, (_, str, str2) => `$\{${str || str2}}`);
                     // 为 path 中的 params 添加 alias
                     const escapedPathParams = (0, lodash_1.map)(params.path, (item, index) => (Object.assign(Object.assign({}, item), { alias: `param${index}` })));
@@ -701,6 +711,108 @@ class ServiceGenerator {
         responseSchema.type = this.getType(schema, this.config.namespace);
         return responseSchema;
     }
+    /**
+     * 生成多状态码响应类型定义
+     * 将 OpenAPI 的 responses 对象转换为 TypeScript 类型定义
+     * 例如：{ 200: ResponseType, 400: unknown, 404: unknown }
+     *
+     * @param responses OpenAPI 响应对象
+     * @param functionName 函数名称，用于生成主响应类型名称
+     * @returns 多状态码响应类型定义字符串，如果没有响应则返回 null
+     */
+    getResponsesType(responses = {}, functionName) {
+        if ((0, lodash_1.isEmpty)(responses) ||
+            ~(0, lodash_1.findIndex)(this.interfaceTPConfigs, (item) => item.typeName === (0, lodash_1.upperFirst)(`${functionName}Responses`))) {
+            return null;
+        }
+        const { components } = this.openAPIData;
+        // 生成主响应类型名称
+        const mainResponseTypeName = (0, lodash_1.upperFirst)(`${functionName}Response`);
+        const responseEntries = this.parseResponseEntries(responses, components);
+        const responseTypes = responseEntries.map(({ statusCode, type, description = '' }) => {
+            var _a;
+            // 检查是否已存在对应的主响应类型，如果存在则复用，避免重复定义
+            const existType = this.interfaceTPConfigs.find((item) => item.typeName === mainResponseTypeName);
+            const lastType = existType ? mainResponseTypeName : type;
+            // 格式化描述文本，让描述支持换行
+            const formattedDescription = config_2.lineBreakReg.test(description)
+                ? (_a = description.split('\n')) === null || _a === void 0 ? void 0 : _a.join('\n * ')
+                : description;
+            // 生成带注释的类型定义
+            return formattedDescription
+                ? `  /**\n   * ${formattedDescription}\n   */\n  ${statusCode}: ${lastType};`
+                : `  ${statusCode}: ${lastType};`;
+        });
+        // 返回完整的对象类型定义
+        return `{\n${responseTypes.join('\n')}\n}`;
+    }
+    /**
+     * 解析响应条目，提取每个状态码对应的类型和描述信息
+     *
+     * @param responses OpenAPI 响应对象
+     * @param components OpenAPI 组件对象，用于解析引用类型
+     * @returns 响应条目数组，包含状态码、类型和描述
+     */
+    parseResponseEntries(responses, components) {
+        return (0, lodash_1.keys)(responses).map((statusCode) => {
+            const response = this.resolveRefObject(responses[statusCode]);
+            if (!response) {
+                return { statusCode, type: 'unknown', description: '' };
+            }
+            const responseType = this.getResponseTypeFromContent(response, components);
+            const description = response.description || '';
+            return { statusCode, type: responseType, description };
+        });
+    }
+    /**
+     * 从响应内容中提取 TypeScript 类型
+     * 处理不同的媒体类型和 schema 类型
+     *
+     * @param response 响应对象
+     * @param components OpenAPI 组件对象
+     * @returns TypeScript 类型字符串
+     */
+    getResponseTypeFromContent(response, components) {
+        var _a;
+        if (!response.content) {
+            return 'unknown';
+        }
+        const resContent = response.content;
+        const resContentMediaTypes = (0, lodash_1.keys)(resContent);
+        const mediaType = resContentMediaTypes.includes('application/json')
+            ? 'application/json'
+            : resContentMediaTypes[0];
+        if (!(0, lodash_1.isObject)(resContent) || !mediaType) {
+            return 'unknown';
+        }
+        let schema = (resContent[mediaType].schema ||
+            config_2.DEFAULT_SCHEMA);
+        if ((0, util_2.isReferenceObject)(schema)) {
+            const refName = (0, util_2.getLastRefName)(schema.$ref);
+            const childrenSchema = components.schemas[refName];
+            // 如果配置了 dataFields，尝试从指定字段提取类型
+            if ((0, util_2.isNonArraySchemaObject)(childrenSchema) && this.config.dataFields) {
+                schema = (((_a = this.config.dataFields
+                    .map((field) => childrenSchema.properties[field])
+                    .filter(Boolean)) === null || _a === void 0 ? void 0 : _a[0]) ||
+                    resContent[mediaType].schema ||
+                    config_2.DEFAULT_SCHEMA);
+            }
+            return this.getType(schema);
+        }
+        else if ((0, util_2.isSchemaObject)(schema)) {
+            // 设置属性的 required 状态
+            (0, lodash_1.keys)(schema.properties).map((fieldName) => {
+                var _a, _b;
+                schema.properties[fieldName]['required'] =
+                    (_b = (_a = schema.required) === null || _a === void 0 ? void 0 : _a.includes(fieldName)) !== null && _b !== void 0 ? _b : false;
+            });
+            return this.getType(schema);
+        }
+        else {
+            return this.getType(schema);
+        }
+    }
     getParamsTP(parameters = [], path = null) {
         const templateParams = {};
         if (parameters === null || parameters === void 0 ? void 0 : parameters.length) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi-ts-request",
-  "version": "1.6.7",
+  "version": "1.7.0",
   "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",