swagger2api-v3 1.0.10 → 1.1.1

package/README.md

@@ -75,12 +75,14 @@ npx swagger2api-v3 generate
 |--------|------|---------|-------------|
 | `input` | string | - | Swagger JSON file path or URL |
 | `output` | string | `'./src/api'` | Output directory for generated code |
-| `generator` | string | `'typescript'` | Code generator type |
+| `generator` | string | `'typescript'` | Code generator type. Supports `'typescript'` and `'javascript'`. `'javascript'` outputs `.js` files and skips type file generation |
 | `groupByTags` | boolean | `true` | Whether to group files by tags |
 | `overwrite` | boolean | `true` | Whether to overwrite existing files |
 | `prefix` | string | `''` | Common prefix for API paths |
 | `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
@@ -89,7 +91,7 @@ npx swagger2api-v3 generate
 
 ```
 src/api/
-├── types.ts           # Data type definitions
+├── types.ts           # Data type definitions (TypeScript mode only)
 ├── user/              # User-related APIs
 │   └── index.ts
 ├── auth/              # Auth-related APIs
@@ -97,6 +99,30 @@ src/api/
 └── index.ts          # Entry file
 ```
 
+### JavaScript Output
+
+When `generator: 'javascript'` is set:
+
+- Outputs `.js` files (`index.js`, `api.js`, `user/index.js`, etc.)
+- Does not generate a `types.ts` file
+- Removes TypeScript-specific syntax (types, `import type`, generics like `<T>`)
+
+Example generated API function (method style):
+
+```javascript
+export const codeAuth = (data, config) => {
+  return request.post({ url: '/api/auth/codeAuth', data, ...config });
+};
+```
+
+Example generated API function (generic style):
+
+```javascript
+export const codeAuth = (data, config) => {
+  return request({ url: '/api/auth/codeAuth', method: 'POST', data, ...config });
+};
+```
+
 ### Not Grouped
 
 ```
@@ -146,6 +172,16 @@ export const authControllerLoginPost = (data: LoginDto, config?: any) => {
     ...config
   });
 };
+
+// When requestStyle is set to 'generic':
+export const authControllerLoginPost2 = (data: LoginDto, config?: any) => {
+  return request<LoginRespDto>({
+    url: '/admin/auth/login',
+    data,
+    method: 'POST',
+    ...config
+  });
+};
 ```
 
 ## 🔧 CLI Commands

package/dist/cli/index.js

@@ -125,7 +125,10 @@ const config = {
   importTemplate: "import { request } from '@/utils/request';",
   
   // 生成器类型
-  generator: 'typescript',
+  generator: 'typescript', // 可选 'javascript'（JS 模式输出 .js 文件且不生成类型文件）
+  
+  // 请求调用风格：'method' 使用 request.get/post；'generic' 使用 request({ method })
+  requestStyle: 'generic',
   
   // 按标签分组生成文件
   groupByTags: true,
@@ -139,6 +142,11 @@ const config = {
   // 代码格式化命令（可选）
   lint: 'prettier --write',
   
+  // 生成方法名时需要忽略的前缀（可选）
+  // 例如：配置 ['api', 'auth'] 后，apiGetName 会变成 getName，authUserInfo 会变成 userInfo
+  // 如果方法名是 apiAuthGetName，会依次移除所有匹配的前缀，最终变成 getName
+  methodNameIgnorePrefix: [],
+  
   // 生成选项
   options: {
     // 是否添加注释

package/dist/core/generator.js

@@ -57,8 +57,9 @@ class CodeGenerator {
         }
         // 确保输出目录存在
         (0, utils_1.ensureDirectoryExists)(this.config.output);
-        // 生成类型文件
-        if (this.config.options?.generateModels !== false) {
+        // 生成类型文件（仅在 TypeScript 模式下生成）
+        if (this.config.generator === 'typescript' &&
+            this.config.options?.generateModels !== false) {
             await this.generateTypesFile(types);
         }
         // 生成API文件
@@ -97,7 +98,7 @@ class CodeGenerator {
         const header = [
             '/**',
             ' * API 类型定义',
-            ' * 此文件由 swagger2api 自动生成，请勿手动修改',
+            ' * 此文件由 swagger2api-v3 自动生成，请勿手动修改',
             ' */',
             ''
         ].join('\n');
@@ -130,7 +131,8 @@ class CodeGenerator {
             const tagFolderPath = path.join(this.config.output, folderName);
             // 确保tag文件夹存在
             (0, utils_1.ensureDirectoryExists)(tagFolderPath);
-            const filePath = path.join(tagFolderPath, 'index.ts');
+            const ext = this.config.generator === 'javascript' ? 'js' : 'ts';
+            const filePath = path.join(tagFolderPath, `index.${ext}`);
             const content = this.generateApiFileContent(apis, types, tag);
             (0, utils_1.writeFile)(filePath, content);
         }
@@ -141,7 +143,8 @@ class CodeGenerator {
      * @param types 类型定义数组
      */
     async generateSingleApiFile(apis, types) {
-        const filePath = path.join(this.config.output, 'api.ts');
+        const ext = this.config.generator === 'javascript' ? 'js' : 'ts';
+        const filePath = path.join(this.config.output, `api.${ext}`);
         const content = this.generateApiFileContent(apis, types);
         (0, utils_1.writeFile)(filePath, content);
     }
@@ -157,15 +160,17 @@ class CodeGenerator {
         const header = [
             '/**',
             ` * ${tag ? `${tag} ` : ''}API 接口`,
-            ' * 此文件由 swagger2api 自动生成，请勿手动修改',
+            ' * 此文件由 swagger2api-v3 自动生成，请勿手动修改',
             ' */',
             '',
             importTemplate + ';'
         ];
         // 收集当前文件实际使用的类型
         const usedTypes = this.collectUsedTypes(apis);
-        // 添加类型导入
-        if (usedTypes.length > 0) {
+        // 添加类型导入（仅在 TypeScript 且生成类型文件时）
+        if (this.config.generator === 'typescript' &&
+            this.config.options?.generateModels !== false &&
+            usedTypes.length > 0) {
             const typeNames = usedTypes.join(', ');
             const typesPath = tag ? '../types' : './types';
             header.push(`import type { ${typeNames} } from '${typesPath}';`);
@@ -204,13 +209,25 @@ class CodeGenerator {
             schema: p.schema || { type: p.type }
         }));
         // 生成直接参数形式
-        const functionParams = this.generateDirectParameters(swaggerParameters);
+        const functionParams = this.generateDirectParameters(swaggerParameters, this.config.generator === 'javascript');
         const responseType = api.responseType || 'any';
         const functionName = (0, utils_1.toCamelCase)(api.name);
         parts.push(`export const ${functionName} = (${functionParams}) => {`);
         // 生成请求配置
-        const requestConfig = this.generateRequestConfig(api);
-        parts.push(`  return request.${api.method.toLowerCase()}<${responseType}>(${requestConfig});`);
+        const useGenericRequest = this.config.requestStyle === 'generic';
+        const requestConfig = this.generateRequestConfig(api, useGenericRequest);
+        const isJS = this.config.generator === 'javascript';
+        if (useGenericRequest) {
+            parts.push(isJS
+                ? `  return request(${requestConfig});`
+                : `  return request<${responseType}>(${requestConfig});`);
+        }
+        else {
+            const method = api.method.toLowerCase();
+            parts.push(isJS
+                ? `  return request.${method}(${requestConfig});`
+                : `  return request.${method}<${responseType}>(${requestConfig});`);
+        }
         parts.push('}');
         return parts.join('\n');
     }
@@ -219,7 +236,7 @@ class CodeGenerator {
      * @param parameters Swagger参数数组
      * @returns 函数参数字符串
      */
-    generateDirectParameters(parameters) {
+    generateDirectParameters(parameters, isJavaScript = false) {
         const params = [];
         const queryParams = parameters.filter((p) => p.in === 'query');
         const pathParams = parameters.filter((p) => p.in === 'path');
@@ -228,37 +245,52 @@ class CodeGenerator {
         // 合并路径参数和查询参数为一个params对象
         const allParams = [...pathParams, ...queryParams];
         if (allParams.length > 0) {
-            const paramType = allParams
-                .map((p) => {
-                const optional = p.required ? '' : '?';
-                return `${p.name}${optional}: ${p.type}`;
-            })
-                .join(', ');
-            // 检查是否所有参数都是可选的
-            const allOptional = allParams.every((p) => !p.required);
-            const optionalModifier = allOptional ? '?' : '';
-            params.push(`params${optionalModifier}: { ${paramType} }`);
+            if (isJavaScript) {
+                params.push('params');
+            }
+            else {
+                const paramType = allParams
+                    .map((p) => {
+                    const optional = p.required ? '' : '?';
+                    return `${p.name}${optional}: ${p.type}`;
+                })
+                    .join(', ');
+                // 检查是否所有参数都是可选的
+                const allOptional = allParams.every((p) => !p.required);
+                const optionalModifier = allOptional ? '?' : '';
+                params.push(`params${optionalModifier}: { ${paramType} }`);
+            }
         }
         // 请求体参数
         if (bodyParams.length > 0) {
-            const bodyParam = bodyParams[0];
-            const bodyType = bodyParam.schema
-                ? this.getTypeFromSchema(bodyParam.schema)
-                : bodyParam.type;
-            params.push(`data: ${bodyType}`);
+            if (isJavaScript) {
+                params.push('data');
+            }
+            else {
+                const bodyParam = bodyParams[0];
+                const bodyType = bodyParam.schema
+                    ? this.getTypeFromSchema(bodyParam.schema)
+                    : bodyParam.type;
+                params.push(`data: ${bodyType}`);
+            }
         }
         // 表单参数
         if (formParams.length > 0) {
-            const formType = formParams
-                .map((p) => {
-                const optional = p.required ? '' : '?';
-                return `${p.name}${optional}: ${p.type}`;
-            })
-                .join(', ');
-            params.push(`data: { ${formType} }`);
+            if (isJavaScript) {
+                params.push('data');
+            }
+            else {
+                const formType = formParams
+                    .map((p) => {
+                    const optional = p.required ? '' : '?';
+                    return `${p.name}${optional}: ${p.type}`;
+                })
+                    .join(', ');
+                params.push(`data: { ${formType} }`);
+            }
         }
         // 添加可选的config参数
-        params.push('config?: any');
+        params.push(isJavaScript ? 'config' : 'config?: any');
         return params.join(', ');
     }
     /**
@@ -363,7 +395,7 @@ class CodeGenerator {
      * @param api API接口信息
      * @returns 请求配置代码
      */
-    generateRequestConfig(api) {
+    generateRequestConfig(api, includeMethod = false) {
         const config = [];
         // URL处理
         let url = api.path;
@@ -397,6 +429,10 @@ class CodeGenerator {
         else if (formParams.length > 0) {
             config.push('data');
         }
+        // 在通用请求风格下添加 method 字段
+        if (includeMethod) {
+            config.push(`method: '${api.method}'`);
+        }
         // 添加config参数合并
         config.push('...config');
         return `{\n    ${config.join(',\n    ')}\n  }`;
@@ -407,8 +443,11 @@ class CodeGenerator {
      */
     async generateIndexFile(groupedApis) {
         const exports = [];
-        // 导出类型
-        exports.push("export * from './types';");
+        // 导出类型（仅在 TypeScript 且生成类型文件时）
+        if (this.config.generator === 'typescript' &&
+            this.config.options?.generateModels !== false) {
+            exports.push("export * from './types';");
+        }
         if (this.config.groupByTags) {
             // 按标签导出
             for (const tag of groupedApis.keys()) {
@@ -423,13 +462,14 @@ class CodeGenerator {
         const content = [
             '/**',
             ' * API 入口文件',
-            ' * 此文件由 swagger2api 自动生成，请勿手动修改',
+            ' * 此文件由 swagger2api-v3 自动生成，请勿手动修改',
             ' */',
             '',
             ...exports,
             ''
         ].join('\n');
-        const filePath = path.join(this.config.output, 'index.ts');
+        const ext = this.config.generator === 'javascript' ? 'js' : 'ts';
+        const filePath = path.join(this.config.output, `index.${ext}`);
         (0, utils_1.writeFile)(filePath, content);
     }
     /**

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/index.js

@@ -48,7 +48,12 @@ const utils_1 = require("./utils");
  */
 class Swagger2API {
     constructor(config) {
-        this.config = config;
+        // 规范化配置：设置默认值
+        this.config = {
+            ...config,
+            // 默认请求风格为 generic
+            requestStyle: config.requestStyle ?? 'generic'
+        };
     }
     /**
      * 生成API接口文件
@@ -95,8 +100,10 @@ class Swagger2API {
         if (!this.config.output) {
             errors.push('output 配置项不能为空');
         }
-        if (this.config.generator !== 'typescript') {
-            errors.push('目前只支持 typescript 生成器');
+        // 支持 typescript 与 javascript 两种生成器
+        if (this.config.generator !== 'typescript' &&
+            this.config.generator !== 'javascript') {
+            errors.push('目前只支持 typescript 或 javascript 生成器');
         }
         if (errors.length > 0) {
             console.error('❌ 配置验证失败:');

package/dist/types/index.d.ts

@@ -10,13 +10,15 @@ export interface SwaggerConfig {
     /** 输出目录 */
     output: string;
     /** 生成器类型 */
-    generator: 'typescript';
+    generator: 'typescript' | 'javascript';
     /** 按 tags 分组生成文件 */
     groupByTags: boolean;
     /** 是否覆盖更新，默认为true。为true时会先删除输出目录下的所有文件 */
     overwrite?: boolean;
     /** 接口路径公共前缀，默认为空字符串 */
     prefix?: string;
+    /** 请求调用风格：'method' 使用 request.get/post；'generic' 使用 request({ method }) */
+    requestStyle?: 'method' | 'generic';
     /** 标签分组配置 */
     tagGrouping?: TagGroupingConfig;
     /** 生成选项 */
@@ -27,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,7 +1,7 @@
 {
   "name": "swagger2api-v3",
-  "version": "1.0.10",
-  "description": "从 Swagger(OAS3.0) 文档生成 TypeScript API 接口的命令行工具",
+  "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",
   "type": "commonjs",
@@ -65,4 +65,4 @@
     "axios": "^1.11.0",
     "commander": "^12.0.0"
   }
-}
+}

package/dist/utils/request.d.ts

@@ -1,17 +0,0 @@
-import { type AxiosRequestConfig, type AxiosResponse, type CreateAxiosDefaults, type InternalAxiosRequestConfig } from 'axios';
-export interface IReqBoay<T> {
-    code: number;
-    data: T;
-    message: string;
-}
-declare class HttpRequest {
-    private instance;
-    constructor(options: CreateAxiosDefaults);
-    requestInterceptors(config: InternalAxiosRequestConfig): InternalAxiosRequestConfig<any>;
-    responseInterceptors(response: AxiosResponse): any;
-    private request;
-    get<T = any>({ ...config }: AxiosRequestConfig): Promise<IReqBoay<T>>;
-    post<T = any>({ ...config }: AxiosRequestConfig): Promise<IReqBoay<T>>;
-}
-export declare const request: HttpRequest;
-export {};

package/dist/utils/request.js

@@ -1,49 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.request = void 0;
-const axios_1 = __importDefault(require("axios"));
-class HttpRequest {
-    constructor(options) {
-        this.instance = axios_1.default.create(options);
-        this.instance.interceptors.request.use(this.requestInterceptors);
-        this.instance.interceptors.response.use(this.responseInterceptors);
-    }
-    requestInterceptors(config) {
-        return config;
-    }
-    responseInterceptors(response) {
-        return response.data;
-    }
-    request(config) {
-        return new Promise((resolve, reject) => {
-            this.instance
-                .request(config)
-                .then((res) => {
-                console.log('request:', res);
-                resolve(res);
-            })
-                .catch((err) => {
-                reject(err.message);
-            });
-        });
-    }
-    get({ ...config }) {
-        return this.request({
-            ...config,
-            method: 'GET'
-        });
-    }
-    post({ ...config }) {
-        return this.request({
-            ...config,
-            method: 'POST'
-        });
-    }
-}
-exports.request = new HttpRequest({
-    baseURL: ``,
-    timeout: 20000
-});