swagger2api-v3 1.1.0 → 1.1.1

package/README.md

@@ -82,6 +82,7 @@ npx swagger2api-v3 generate
 | `importTemplate` | string | - | Import statement template for request function |
 | `requestStyle` | 'method' \| 'generic' | `'generic'` | Request call style: `method` uses `request.get/post`, `generic` uses `request({ method })` |
 | `lint` | string | - | Code formatting command (optional) |
+| `methodNameIgnorePrefix` | string[] | `[]` | Array of prefixes to ignore when generating method names. For example, `['api', 'auth']` will transform `apiGetName` to `getName` and `authUserInfo` to `userInfo` |
 | `options.addComments` | boolean | `true` | Whether to add detailed comments |
 
 ## 📁 Generated File Structure

package/dist/cli/index.js

@@ -142,6 +142,11 @@ const config = {
   // 代码格式化命令（可选）
   lint: 'prettier --write',
   
+  // 生成方法名时需要忽略的前缀（可选）
+  // 例如：配置 ['api', 'auth'] 后，apiGetName 会变成 getName，authUserInfo 会变成 userInfo
+  // 如果方法名是 apiAuthGetName，会依次移除所有匹配的前缀，最终变成 getName
+  methodNameIgnorePrefix: [],
+  
   // 生成选项
   options: {
     // 是否添加注释

package/dist/core/parser.js

@@ -76,6 +76,8 @@ class SwaggerParser {
             const methodSuffix = method.charAt(0).toUpperCase() + method.slice(1).toLowerCase();
             functionName = functionName + methodSuffix;
         }
+        // 应用前缀忽略规则
+        functionName = (0, utils_1.stripMethodNamePrefixes)(functionName, this.config.methodNameIgnorePrefix);
         // 获取响应类型
         const responseType = (0, utils_1.getResponseType)(operation.responses);
         // 获取请求体类型

package/dist/types/index.d.ts

@@ -29,6 +29,8 @@ export interface SwaggerConfig {
     importTemplate?: string;
     /** 格式化代码命令 */
     lint?: string;
+    /** 生成方法名时需要忽略的前缀数组，如 ['api', 'auth'] */
+    methodNameIgnorePrefix?: string[];
 }
 /**
  * 标签分组配置

package/dist/utils/index.d.ts

@@ -27,6 +27,13 @@ export declare function toPascalCase(str: string): string;
  * @returns camelCase字符串
  */
 export declare function toCamelCase(str: string): string;
+/**
+ * 从方法名中移除指定的前缀
+ * @param methodName 方法名
+ * @param prefixes 需要移除的前缀数组
+ * @returns 移除前缀后的方法名
+ */
+export declare function stripMethodNamePrefixes(methodName: string, prefixes?: string[]): string;
 /**
  * 将Swagger类型转换为TypeScript类型
  * @param schema Swagger模式

package/dist/utils/index.js

@@ -40,6 +40,7 @@ exports.pathToFunctionName = pathToFunctionName;
 exports.toKebabCase = toKebabCase;
 exports.toPascalCase = toPascalCase;
 exports.toCamelCase = toCamelCase;
+exports.stripMethodNamePrefixes = stripMethodNamePrefixes;
 exports.swaggerTypeToTsType = swaggerTypeToTsType;
 exports.generateParameterTypes = generateParameterTypes;
 exports.ensureDirectoryExists = ensureDirectoryExists;
@@ -111,6 +112,44 @@ function toCamelCase(str) {
     const pascalCase = toPascalCase(str);
     return pascalCase.charAt(0).toLowerCase() + pascalCase.slice(1);
 }
+/**
+ * 从方法名中移除指定的前缀
+ * @param methodName 方法名
+ * @param prefixes 需要移除的前缀数组
+ * @returns 移除前缀后的方法名
+ */
+function stripMethodNamePrefixes(methodName, prefixes) {
+    if (!prefixes || prefixes.length === 0) {
+        return methodName;
+    }
+    let result = methodName;
+    // 循环移除所有匹配的前缀，直到没有前缀可以移除
+    let changed = true;
+    while (changed) {
+        changed = false;
+        for (const prefix of prefixes) {
+            if (!prefix)
+                continue;
+            // 将前缀转换为小驼峰格式进行匹配
+            const camelPrefix = toCamelCase(prefix);
+            // 检查方法名是否以该前缀开头（不区分大小写）
+            const lowerMethodName = result.toLowerCase();
+            const lowerPrefix = camelPrefix.toLowerCase();
+            if (lowerMethodName.startsWith(lowerPrefix)) {
+                // 移除前缀，保持后续字符的大小写
+                const remaining = result.substring(camelPrefix.length);
+                // 如果移除前缀后还有内容，则更新结果
+                if (remaining.length > 0) {
+                    // 确保首字母小写
+                    result = remaining.charAt(0).toLowerCase() + remaining.slice(1);
+                    changed = true;
+                    break; // 重新开始检查
+                }
+            }
+        }
+    }
+    return result;
+}
 /**
  * 将Swagger类型转换为TypeScript类型
  * @param schema Swagger模式

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swagger2api-v3",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "A command-line tool for generating TypeScript API interfaces from Swagger (OAS 3.0) documentation",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -65,4 +65,4 @@
     "axios": "^1.11.0",
     "commander": "^12.0.0"
   }
-}
+}