openapi-ts-request 0.12.1 → 0.13.0

package/README.md

@@ -4,13 +4,13 @@
 
 <a href="https://github.com/openapi-ui/openapi-ts-request/blob/master/README-en_US.md">English</a> | 简体中文
 
-根据 [Swagger2/OpenAPI3](https://swagger.io/blog/news/whats-new-in-openapi-3-0/) 文档生成 TS 类型, 客户端请求函数, 模拟请求响应服务, 枚举, 类型字段翻译, JSON Schemas
+根据 [Swagger2/OpenAPI3/Apifox](https://swagger.io/blog/news/whats-new-in-openapi-3-0/) 文档生成 TS 类型, 客户端请求函数, 模拟请求响应服务, 枚举, 类型字段翻译, JSON Schemas
 
 文档：[使用手册](https://github.com/openapi-ui/openapi-ts-request/issues/100)
 
 ## 功能
 
-- 支持 Swagger2.0/OpenAPI 3.0,3.1 定义
+- 支持 Swagger2.0/OpenAPI/Apifox 3.0,3.1 定义
 - 生成 TS 类型, 请求客户端, 请求模拟服务, 枚举, 类型字段翻译, JSON Schemas
 - 支持通过 npx、CLI、Nodejs 的方式使用
 - 支持自定义请求工具函数, 支持 Fetch、Axios、[UniApp-Request](https://github.com/openapi-ui/openapi-ts-request/issues/46)、Node.js、XHR 客户端
@@ -136,8 +136,13 @@ $ openapi --help
     -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 is "axios"
-    --allowedTags <string[]>           generate code from allowed tags
+    --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 =
@@ -146,7 +151,7 @@ $ openapi --help
                                       "'api'"(string)
     --isDisplayTypeLabel <boolean>     generate label matching type field (default: false)
     --isGenJsonSchemas <boolean>       generate JSON Schemas (default: false)
-    --mockFolder <string>              mock file path
+    --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)
@@ -168,13 +173,18 @@ openapi --i ./spec.json --o ./apis
 | schemaPath | 是 | string | - | Swagger2/OpenAPI3 地址 |
 | serversPath | 否 | string | './src/apis' | 生成结果的文件夹路径 |
 | requestLibPath | 否 | string | 'axios' | 自定义请求方法路径，例如：'@/request'、'node-fetch' |
-| allowedTags | 否 | string[] | - | 根据指定的 tags 生成代码 |
+| enableLogging | 否 | boolean | false | 是否开启日志 |
+| priorityRule | 否 | string | 'include' | 模式规则，可选include/exclude/both |
+| includeTags | 否 | (string\|RegExp)[] | - | 根据指定的 tags 生成代码, priorityRule=include则必填 |
+| includePaths | 否 | (string\|RegExp)[] | - | 根据指定的 paths 生成代码 |
+| excludeTags | 否 | (string\|RegExp)[] | - | 根据指定的 tags 不生成代码 |
+| excludePaths | 否 | (string\|RegExp)[] | - | 根据指定的 paths 不生成代码 |
 | requestOptionsType | 否 | string | '{ [key: string]: unknown }' | 自定义请求方法 options 参数类型 |
 | requestImportStatement | 否 | string | - | 自定义请求方法表达式，例如："const request = require('@/request')" |
 | apiPrefix | 否 | string | - | api path的前缀，例如：'api'(动态变量), "'api'"(字符串) |
 | isDisplayTypeLabel | 否 | boolean | false | 是否生成 type 对应的label |
 | isGenJsonSchemas | 否 | boolean | false | 是否生成 JSON Schemas |
-| mockFolder | 否 | string | './mocks' | mock文件路径 |
+| mockFolder | 否 | string | - | mock文件路径，例如：'./mocks' |
 | authorization | 否 | string | - | 文档权限凭证 |
 | nullable | 否 | boolean | false | 使用 null 代替可选 |
 | isTranslateToEnglishTag | 否 | boolean | false | 将中文 tag 名称翻译成英文 tag 名称 |

package/dist/bin/openapi.js

@@ -12,8 +12,13 @@ const params = commander_1.program
     .version(pkg.version)
     .requiredOption('-i, --input <string>', 'OpenAPI specification, can be a path, url (required)')
     .requiredOption('-o, --output <string>', 'output directory (required)')
-    .option('--requestLibPath <string>', 'custom request lib path, for example: "@/request", "node-fetch", default is "axios"')
-    .option('--allowedTags <string[]>', 'generate results from allowed tags')
+    .option('--requestLibPath <string>', 'custom request lib path, for example: "@/request", "node-fetch" (default: "axios")')
+    .option('--enableLogging <boolean>', 'open the log', false)
+    .option('--priorityRule <string>', 'priority rule, include/exclude/both (default: "include")')
+    .option('--includeTags <(string|RegExp)[]>', 'generate code from include tags')
+    .option('--includePaths <(string|RegExp)[]>', 'generate code from include paths')
+    .option('--excludeTags <(string|RegExp)[]>', 'generate code from exclude tags')
+    .option('--excludePaths <(string|RegExp)[]>', 'generate code from exclude paths')
     .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)`)
@@ -43,7 +48,12 @@ function run() {
                 schemaPath: input,
                 serversPath: output,
                 requestLibPath: params.requestLibPath,
-                allowedTags: params.allowedTags,
+                enableLogging: JSON.parse(params.enableLogging) === true,
+                priorityRule: params.priorityRule,
+                includeTags: params.includeTags,
+                includePaths: params.includePaths,
+                excludeTags: params.excludeTags,
+                excludePaths: params.excludePaths,
                 requestOptionsType: params.requestOptionsType,
                 apiPrefix: params.apiPrefix,
                 isDisplayTypeLabel: JSON.parse(params.isDisplayTypeLabel) === true,

package/dist/generator/serviceGenarator.d.ts

@@ -29,4 +29,18 @@ export default class ServiceGenerator {
     private resolveAllOfObject;
     private getProps;
     private resolveRefObject;
+    log(message: string): void;
+    private generateInfoLog;
+    /**
+     * 校验规则
+     * @param regexp 正则数组
+     * @param data 数据
+     */
+    private validateRegexp;
+    /**
+     *
+     * @param item 数组数据
+     * @param reg 规则
+     */
+    private matches;
 }

package/dist/generator/serviceGenarator.js

@@ -4,6 +4,7 @@ const tslib_1 = require("tslib");
 const fs_1 = require("fs");
 const glob_1 = require("glob");
 const lodash_1 = require("lodash");
+const minimatch_1 = require("minimatch");
 const nunjucks_1 = tslib_1.__importDefault(require("nunjucks"));
 const path_1 = require("path");
 const rimraf_1 = require("rimraf");
@@ -15,14 +16,19 @@ const patchSchema_1 = require("./patchSchema");
 const util_1 = require("./util");
 class ServiceGenerator {
     constructor(config, openAPIData) {
-        var _a, _b;
+        var _a, _b, _c, _d, _e;
         this.apiData = {};
         this.classNameList = [];
         this.schemaList = [];
         this.finalPath = '';
         this.config = Object.assign({ templatesFolder: (0, path_1.join)(__dirname, '../../', 'templates') }, config);
-        const hookCustomFileNames = ((_a = this.config.hook) === null || _a === void 0 ? void 0 : _a.customFileNames) || util_1.getDefaultFileTag;
-        if ((_b = this.config.hook) === null || _b === void 0 ? void 0 : _b.afterOpenApiDataInited) {
+        this.generateInfoLog();
+        const includeTags = ((_a = this.config) === null || _a === void 0 ? void 0 : _a.includeTags) || [];
+        const includePaths = ((_b = this.config) === null || _b === void 0 ? void 0 : _b.includePaths) || [];
+        const excludeTags = ((_c = this.config) === null || _c === void 0 ? void 0 : _c.excludeTags) || [];
+        const excludePaths = ((_d = this.config) === null || _d === void 0 ? void 0 : _d.excludePaths) || [];
+        const priorityRule = type_1.PriorityRule[config.priorityRule];
+        if ((_e = this.config.hook) === null || _e === void 0 ? void 0 : _e.afterOpenApiDataInited) {
             this.openAPIData =
                 this.config.hook.afterOpenApiDataInited(openAPIData) || openAPIData;
         }
@@ -30,23 +36,85 @@ class ServiceGenerator {
             this.openAPIData = openAPIData;
         }
         // 用 tag 分组 paths, { [tag]: [pathMap, pathMap] }
-        (0, lodash_1.keys)(this.openAPIData.paths).forEach((pathKey) => {
+        outerLoop: for (const pathKey in this.openAPIData.paths) {
+            // 这里判断paths
+            switch (priorityRule) {
+                case type_1.PriorityRule.include: {
+                    // includePaths and includeTags is empty, 直接跳过
+                    if ((0, lodash_1.isEmpty)(includeTags) && (0, lodash_1.isEmpty)(includePaths)) {
+                        this.log('priorityRule include need includeTags or includePaths');
+                        break outerLoop;
+                    }
+                    if (!(0, lodash_1.isEmpty)(includePaths) &&
+                        !this.validateRegexp(pathKey, includePaths)) {
+                        continue;
+                    }
+                    break;
+                }
+                case type_1.PriorityRule.exclude: {
+                    if (this.validateRegexp(pathKey, excludePaths)) {
+                        continue;
+                    }
+                    break;
+                }
+                case type_1.PriorityRule.both: {
+                    // includePaths and includeTags is empty，直接跳过
+                    if ((0, lodash_1.isEmpty)(includeTags) && (0, lodash_1.isEmpty)(includePaths)) {
+                        this.log('priorityRule both need includeTags or includePaths');
+                        break outerLoop;
+                    }
+                    const outIncludePaths = !(0, lodash_1.isEmpty)(includePaths) &&
+                        !this.validateRegexp(pathKey, includePaths);
+                    const inExcludePaths = !(0, lodash_1.isEmpty)(excludePaths) &&
+                        this.validateRegexp(pathKey, excludePaths);
+                    if (outIncludePaths || inExcludePaths) {
+                        continue;
+                    }
+                    break;
+                }
+                default:
+                    throw new Error('priorityRule must be "include" or "exclude" or "include"');
+            }
             const pathItem = this.openAPIData.paths[pathKey];
             (0, lodash_1.forEach)(config_1.methods, (method) => {
+                var _a;
                 const operationObject = pathItem[method];
                 if (!operationObject) {
                     return;
                 }
-                let tags = hookCustomFileNames(operationObject, pathKey, method);
-                if (!tags) {
-                    tags = (0, util_1.getDefaultFileTag)(operationObject, pathKey);
-                }
+                const hookCustomFileNames = ((_a = this.config.hook) === null || _a === void 0 ? void 0 : _a.customFileNames) || util_1.getDefaultFileTag;
+                const tags = hookCustomFileNames(operationObject, pathKey, method);
+                // 这里判断tags
                 tags.forEach((tag) => {
-                    var _a;
-                    // 筛选出 tags 关联的paths
-                    if (!(0, lodash_1.isEmpty)((_a = this.config) === null || _a === void 0 ? void 0 : _a.allowedTags) &&
-                        !(0, lodash_1.includes)(this.config.allowedTags, tag.toLowerCase())) {
-                        return;
+                    const tagLowerCase = tag.toLowerCase();
+                    if (priorityRule === type_1.PriorityRule.include) {
+                        // includeTags 为空，不会匹配任何path，故跳过
+                        if ((0, lodash_1.isEmpty)(includeTags)) {
+                            this.log('priorityRule include need includeTags or includePaths');
+                            return;
+                        }
+                        if (!this.validateRegexp(tagLowerCase, includeTags)) {
+                            return;
+                        }
+                    }
+                    if (priorityRule === type_1.PriorityRule.exclude) {
+                        if (this.validateRegexp(tagLowerCase, excludeTags)) {
+                            return;
+                        }
+                    }
+                    if (priorityRule === type_1.PriorityRule.both) {
+                        // includeTags is empty 没有配置, 直接跳过
+                        if ((0, lodash_1.isEmpty)(includeTags)) {
+                            this.log('priorityRule both need includeTags or includePaths');
+                            return;
+                        }
+                        const outIncludeTags = !(0, lodash_1.isEmpty)(includeTags) &&
+                            !this.validateRegexp(tagLowerCase, includeTags);
+                        const inExcludeTags = !(0, lodash_1.isEmpty)(excludeTags) &&
+                            this.validateRegexp(tagLowerCase, excludeTags);
+                        if (outIncludeTags || inExcludeTags) {
+                            return;
+                        }
                     }
                     const tagKey = this.config.isCamelCase
                         ? (0, lodash_1.camelCase)((0, util_1.resolveTypeName)(tag))
@@ -57,7 +125,7 @@ class ServiceGenerator {
                     this.apiData[tagKey].push(Object.assign({ path: pathKey, method }, operationObject));
                 });
             });
-        });
+        }
     }
     genFile() {
         try {
@@ -139,28 +207,30 @@ class ServiceGenerator {
         (0, log_1.default)('✅ 成功生成 api 文件');
     }
     getInterfaceTPConfigs() {
-        var _a;
+        var _a, _b;
         const schemas = (_a = this.openAPIData.components) === null || _a === void 0 ? void 0 : _a.schemas;
         const lastTypes = [];
+        const includeTags = ((_b = this.config) === null || _b === void 0 ? void 0 : _b.includeTags) || [];
         // 强行替换掉请求参数params的类型，生成方法对应的 xxxxParams 类型
         (0, lodash_1.keys)(this.openAPIData.paths).forEach((pathKey) => {
             const pathItem = this.openAPIData.paths[pathKey];
             (0, lodash_1.forEach)(config_1.methods, (method) => {
                 var _a, _b, _c, _d;
                 const operationObject = pathItem[method];
+                const hookCustomFileNames = ((_a = this.config.hook) === null || _a === void 0 ? void 0 : _a.customFileNames) || util_1.getDefaultFileTag;
                 if (!operationObject) {
                     return;
                 }
-                // 筛选出 pathItem 包含的 $ref 对应的schema
-                if (!(0, lodash_1.isEmpty)((_a = this.config) === null || _a === void 0 ? void 0 : _a.allowedTags) &&
-                    !(0, lodash_1.isEmpty)(operationObject.tags)) {
-                    if (!(0, lodash_1.isEmpty)((0, lodash_1.intersection)(this.config.allowedTags, (0, lodash_1.map)(operationObject.tags, (tag) => tag.toLowerCase())))) {
-                        (0, util_1.markAllowedSchema)(JSON.stringify(pathItem), schemas);
-                    }
-                    else {
-                        return;
-                    }
+                const tags = hookCustomFileNames(operationObject, pathKey, method);
+                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);
+                if (!flag) {
+                    return;
                 }
+                // 筛选出 pathItem 包含的 $ref 对应的schema
+                (0, util_1.markAllowedSchema)(JSON.stringify(pathItem), this.openAPIData);
                 operationObject.parameters = (_b = operationObject.parameters) === null || _b === void 0 ? void 0 : _b.filter((item) => (item === null || item === void 0 ? void 0 : item.in) !== `${config_1.parametersInsEnum.header}`);
                 const props = [];
                 (_c = operationObject.parameters) === null || _c === void 0 ? void 0 : _c.forEach((parameter) => {
@@ -196,6 +266,10 @@ class ServiceGenerator {
         (0, lodash_1.keys)(schemas).forEach((schemaKey) => {
             var _a;
             const schema = schemas[schemaKey];
+            // 判断哪些 schema 需要添加进 type, schemas 渲染数组
+            if (!(schema === null || schema === void 0 ? void 0 : schema.isAllowed)) {
+                return;
+            }
             const result = this.resolveObject(schema);
             const getDefinesType = () => {
                 if (result === null || result === void 0 ? void 0 : result.type) {
@@ -223,29 +297,25 @@ class ServiceGenerator {
                     }
                 });
             }
-            // 判断哪些 schema 需要添加进 type, schemas 渲染数组
-            if ((0, lodash_1.isEmpty)(this.config.allowedTags) ||
-                (schema === null || schema === void 0 ? void 0 : schema.isAllowed)) {
-                const isEnum = result.isEnum;
-                const typeName = (0, util_1.resolveTypeName)(schemaKey);
-                if (typeName) {
-                    lastTypes.push({
-                        typeName,
-                        type: getDefinesType(),
-                        props: (result.props || []),
-                        isEnum,
-                        displayLabelFuncName: isEnum
-                            ? (0, lodash_1.camelCase)(`display-${typeName}-Enum`)
-                            : '',
-                        enumLabelType: isEnum ? result.enumLabelType : '',
-                    });
-                }
-                if (this.config.isGenJsonSchemas) {
-                    this.schemaList.push({
-                        typeName: `$${(0, util_1.resolveTypeName)(schemaKey)}`,
-                        type: JSON.stringify((0, patchSchema_1.patchSchema)(schema, (_a = this.openAPIData.components) === null || _a === void 0 ? void 0 : _a.schemas)),
-                    });
-                }
+            const isEnum = result.isEnum;
+            const typeName = (0, util_1.resolveTypeName)(schemaKey);
+            if (typeName) {
+                lastTypes.push({
+                    typeName,
+                    type: getDefinesType(),
+                    props: (result.props || []),
+                    isEnum,
+                    displayLabelFuncName: isEnum
+                        ? (0, lodash_1.camelCase)(`display-${typeName}-Enum`)
+                        : '',
+                    enumLabelType: isEnum ? result.enumLabelType : '',
+                });
+            }
+            if (this.config.isGenJsonSchemas) {
+                this.schemaList.push({
+                    typeName: `$${(0, util_1.resolveTypeName)(schemaKey)}`,
+                    type: JSON.stringify((0, patchSchema_1.patchSchema)(schema, (_a = this.openAPIData.components) === null || _a === void 0 ? void 0 : _a.schemas)),
+                });
             }
         });
         return lastTypes === null || lastTypes === void 0 ? void 0 : lastTypes.sort((a, b) => a.typeName.localeCompare(b.typeName)); // typeName排序
@@ -709,5 +779,58 @@ class ServiceGenerator {
         }
         return refObject;
     }
+    log(message) {
+        if (this.config.enableLogging) {
+            (0, log_1.default)(message);
+        }
+    }
+    generateInfoLog() {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+        this.log(`priorityRule: ${(_a = this.config) === null || _a === void 0 ? void 0 : _a.priorityRule}`);
+        if ((_b = this.config) === null || _b === void 0 ? void 0 : _b.includeTags) {
+            this.log(`includeTags: ${(_c = this.config) === null || _c === void 0 ? void 0 : _c.includeTags.join(', ')}`);
+        }
+        if ((_d = this.config) === null || _d === void 0 ? void 0 : _d.excludeTags) {
+            this.log(`excludeTags: ${(_e = this.config) === null || _e === void 0 ? void 0 : _e.excludeTags.join(', ')}`);
+        }
+        if ((_f = this.config) === null || _f === void 0 ? void 0 : _f.includePaths) {
+            this.log(`includePaths: ${(_g = this.config) === null || _g === void 0 ? void 0 : _g.includePaths.join(', ')}`);
+        }
+        if ((_h = this.config) === null || _h === void 0 ? void 0 : _h.excludePaths) {
+            this.log(`excludePaths: ${(_j = this.config) === null || _j === void 0 ? void 0 : _j.excludePaths.join(', ')}`);
+        }
+    }
+    /**
+     * 校验规则
+     * @param regexp 正则数组
+     * @param data 数据
+     */
+    validateRegexp(data, regexp) {
+        // 确保 data 是数组
+        const dataArray = Array.isArray(data) ? data : [data];
+        this.log(`"Data Array:", ${dataArray.join(',')}`);
+        this.log(`"Regexp Array:", ${regexp.join(',')}`);
+        return dataArray.some((item) => {
+            const result = regexp.some((reg) => this.matches(item, reg));
+            this.log(`"Item:", ${item}, "Matches:", ${result}`);
+            return result;
+        });
+    }
+    /**
+     *
+     * @param item 数组数据
+     * @param reg 规则
+     */
+    // 提取匹配逻辑到单独的函数
+    matches(item, reg) {
+        if (typeof reg === 'string') {
+            return (0, minimatch_1.minimatch)(item, reg);
+        }
+        else if (reg instanceof RegExp) {
+            reg.lastIndex = 0; // 重置正则表达式的 lastIndex 属性
+            return reg.test(item);
+        }
+        return false; // 对于其他类型，返回 false
+    }
 }
 exports.default = ServiceGenerator;

package/dist/generator/util.d.ts

@@ -12,7 +12,7 @@ export declare function genDefaultFunctionName(path: string, pathBasePrefix: str
 export declare function getFinalFileName(s: string): string;
 export declare function replaceDot(s: string): string;
 export declare function resolveFunctionName(functionName: string, methodName: string): string;
-export declare function markAllowedSchema(schemaStr: string, schemas: ComponentsObject['schemas']): void;
+export declare function markAllowedSchema(schemaStr: string, openAPIData: OpenAPIObject): void;
 export declare function isReferenceObject(schema: unknown): schema is ReferenceObject;
 export declare function isSchemaObject(schema: unknown): schema is SchemaObject;
 export declare function isNonArraySchemaObject(schema: unknown): schema is NonArraySchemaObject;

package/dist/generator/util.js

@@ -287,13 +287,15 @@ function resolveFunctionName(functionName, methodName) {
     return functionName;
 }
 // 标记引用的 $ref 对应的schema
-function markAllowedSchema(schemaStr, schemas) {
-    const refs = schemaStr === null || schemaStr === void 0 ? void 0 : schemaStr.match(/#\/components\/schemas\/([\w%«».-]+)/g);
+function markAllowedSchema(schemaStr, openAPIData) {
+    const refs = (0, lodash_1.map)(schemaStr === null || schemaStr === void 0 ? void 0 : schemaStr.match(/"#\/components\/[^"]+"/g), (item) => item.slice(1, -1));
     (0, lodash_1.forEach)(refs, (ref) => {
-        const schema = schemas === null || schemas === void 0 ? void 0 : schemas[getLastRefName(ref)];
+        // const schema = schemas?.[getLastRefName(ref)] as ICustomSchemaObject;
+        const refPaths = ref.split('/');
+        const schema = resolveRefs(openAPIData, refPaths.slice(1));
         if (schema && !schema.isAllowed) {
             schema.isAllowed = true;
-            markAllowedSchema(JSON.stringify(schema), schemas);
+            markAllowedSchema(JSON.stringify(schema), openAPIData);
         }
     });
 }

package/dist/index.d.ts

@@ -18,9 +18,30 @@ export type GenerateServiceProps = {
      */
     requestLibPath?: string;
     /**
-     * 只解析归属于 tags 集合的api 和 schema
+     * 开启日志
      */
-    allowedTags?: string[];
+    enableLogging?: boolean;
+    /**
+    /**
+     * 优先规则, include(只允许include列表) | exclude(只排除exclude列表) | both(允许include列表，排除exclude列表)
+     */
+    priorityRule?: string;
+    /**
+     * 只解析归属于 tags 集合的 api 和 schema
+     */
+    includeTags?: (string | RegExp)[];
+    /**
+     * 只解析归属于 paths 集合的 api
+     */
+    includePaths?: (string | RegExp)[];
+    /**
+     * 不解析归属于 tags 集合的 api 和 schema
+     */
+    excludeTags?: (string | RegExp)[];
+    /**
+     * 不解析归属于 paths 集合的 api
+     */
+    excludePaths?: (string | RegExp)[];
     /**
      * 自定义请求方法 options 参数类型
      */
@@ -143,4 +164,4 @@ export type GenerateServiceProps = {
         customFileNames?: (operationObject: OperationObject, apiPath: string, apiMethod: string) => string[] | null;
     };
 };
-export declare function generateService({ requestLibPath, schemaPath, mockFolder, allowedTags, authorization, isTranslateToEnglishTag, ...rest }: GenerateServiceProps): Promise<void>;
+export declare function generateService({ requestLibPath, schemaPath, mockFolder, includeTags, excludeTags, authorization, isTranslateToEnglishTag, priorityRule, ...rest }: GenerateServiceProps): Promise<void>;

package/dist/index.js

@@ -5,11 +5,12 @@ const tslib_1 = require("tslib");
 const lodash_1 = require("lodash");
 const mockGenarator_1 = require("./generator/mockGenarator");
 const serviceGenarator_1 = tslib_1.__importDefault(require("./generator/serviceGenarator"));
+const type_1 = require("./type");
 const util_1 = require("./util");
 tslib_1.__exportStar(require("./generator/patchSchema"), exports);
 function generateService(_a) {
     return tslib_1.__awaiter(this, void 0, void 0, function* () {
-        var { requestLibPath, schemaPath, mockFolder, allowedTags, authorization, isTranslateToEnglishTag } = _a, rest = tslib_1.__rest(_a, ["requestLibPath", "schemaPath", "mockFolder", "allowedTags", "authorization", "isTranslateToEnglishTag"]);
+        var { requestLibPath, schemaPath, mockFolder, includeTags, excludeTags, authorization, isTranslateToEnglishTag, priorityRule = type_1.PriorityRule.include } = _a, rest = tslib_1.__rest(_a, ["requestLibPath", "schemaPath", "mockFolder", "includeTags", "excludeTags", "authorization", "isTranslateToEnglishTag", "priorityRule"]);
         if (!schemaPath) {
             return;
         }
@@ -21,9 +22,13 @@ function generateService(_a) {
             yield (0, util_1.translateChineseModuleNodeToEnglish)(openAPI);
         }
         const requestImportStatement = (0, util_1.getImportStatement)(requestLibPath);
-        const serviceGenerator = new serviceGenarator_1.default(Object.assign({ schemaPath, serversPath: './src/apis', requestImportStatement, requestOptionsType: '{[key: string]: unknown}', namespace: 'API', nullable: false, isCamelCase: true, isDisplayTypeLabel: false, isGenJsonSchemas: false, isOnlyGenTypeScriptType: false, allowedTags: allowedTags
-                ? (0, lodash_1.map)(allowedTags, (item) => item.toLowerCase())
-                : null }, rest), openAPI);
+        const serviceGenerator = new serviceGenarator_1.default(Object.assign({ schemaPath, serversPath: './src/apis', requestImportStatement, enableLogging: false, priorityRule, includeTags: includeTags
+                ? (0, lodash_1.map)(includeTags, (item) => typeof item === 'string' ? item.toLowerCase() : item)
+                : priorityRule === type_1.PriorityRule.include
+                    ? [/.*/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);
         serviceGenerator.genFile();
         if (mockFolder) {
             (0, mockGenarator_1.mockGenerator)({

package/dist/type.d.ts

@@ -73,5 +73,16 @@ export declare enum SchemaObjectType {
     union = "union",
     file = "file"
 }
+export declare enum PriorityRule {
+    include = "include",
+    exclude = "exclude",
+    both = "both"
+}
+export type GenerateRegExp = {
+    includeTags: (string | RegExp)[];
+    excludeTags: (string | RegExp)[];
+    includePaths: (string | RegExp)[];
+    excludePaths: (string | RegExp)[];
+};
 export type ISchemaObjectType = keyof typeof SchemaObjectType;
 export {};

package/dist/type.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SchemaObjectType = exports.SchemaObjectFormat = void 0;
+exports.PriorityRule = exports.SchemaObjectType = exports.SchemaObjectFormat = void 0;
 var SchemaObjectFormat;
 (function (SchemaObjectFormat) {
     SchemaObjectFormat["int32"] = "int32";
@@ -28,3 +28,9 @@ var SchemaObjectType;
     SchemaObjectType["union"] = "union";
     SchemaObjectType["file"] = "file";
 })(SchemaObjectType || (exports.SchemaObjectType = SchemaObjectType = {}));
+var PriorityRule;
+(function (PriorityRule) {
+    PriorityRule["include"] = "include";
+    PriorityRule["exclude"] = "exclude";
+    PriorityRule["both"] = "both";
+})(PriorityRule || (exports.PriorityRule = PriorityRule = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi-ts-request",
-  "version": "0.12.1",
+  "version": "0.13.0",
   "description": "Swagger2/OpenAPI3 to TypeScript, request client, request mock service, enum, type field label, JSON Schemas",
   "engines": {
     "node": ">=18.0.0",
@@ -36,6 +36,7 @@
     "js-yaml": "^4.1.0",
     "lodash": "^4.17.21",
     "memoizee": "^0.4.17",
+    "minimatch": "^10.0.1",
     "mockjs": "^1.1.0",
     "nunjucks": "^3.2.4",
     "prettier": "^3.3.2",
@@ -64,7 +65,8 @@
     "husky": "^9.0.11",
     "lint-staged": "^15.2.5",
     "openapi-types": "^12.1.3",
-    "typescript": "5.6.3"
+    "ts-node": "^10.9.2",
+    "typescript": "5.7.2"
   },
   "keywords": [
     "openapi",