swagger2api-v3 1.0.0 → 1.0.2

package/README.md

@@ -1,4 +1,4 @@
-# Swagger2API
+# Swagger2API-v3
 
 一个强大的 npm 工具包，用于从 Swagger JSON 文档生成前端接口代码。支持 TypeScript，按标签分组，详细注释生成等功能。
 
@@ -15,13 +15,13 @@
 
 ```bash
 # 使用 pnpm（推荐）
-pnpm add swagger2api
+pnpm add swagger2api-v3
 
 # 使用 npm
-npm install swagger2api
+npm install swagger2api-v3
 
 # 使用 yarn
-yarn add swagger2api
+yarn add swagger2api-v3
 ```
 
 ## 快速开始
@@ -30,7 +30,7 @@ yarn add swagger2api
 
 ```bash
 # 创建基础配置文件
-npx swagger2api init
+npx swagger2api-v3 init
 ```
 
 ### 2. 配置 `.swagger.config.ts`
@@ -62,14 +62,14 @@ const config = {
   }
 };
 
-module.exports = config;
+export default config;
 ```
 
 ### 3. 生成接口代码
 
 ```bash
 # 使用配置文件生成
-npx swagger2api generate
+npx swagger2api-v3 generate
 
 # 或者通过 npm script
 npm run swagger:generate
@@ -82,29 +82,29 @@ npm run swagger:generate
 ```json
 {
   "scripts": {
-    "swagger:generate": "npx swagger2api generate",
-    "swagger:run": "npx swagger2api run",
-    "swagger:init": "npx swagger2api init",
-    "swagger:validate": "npx swagger2api validate"
+    "swagger:generate": "npx swagger2api-v3 generate",
+    "swagger:run": "npx swagger2api-v3 run",
+    "swagger:init": "npx swagger2api-v3 init",
+    "swagger:validate": "npx swagger2api-v3 validate"
   }
 }
 ```
 
 ## CLI 命令
 
-### `swagger2api run`
+### `swagger2api-v3 run`
 
 运行 `.swagger.config.ts` 配置文件生成接口代码：
 
 ```bash
 # 使用默认配置文件
-swagger2api run
+swagger2api-v3 run
 
 # 指定配置文件
-swagger2api run -c ./custom.swagger.config.ts
+swagger2api-v3 run -c ./custom.swagger.config.ts
 ```
 
-### `swagger2api generate`
+### `swagger2api-v3 generate`
 
 使用配置文件生成接口代码：
 
@@ -116,31 +116,31 @@ swagger2api generate
 npm run swagger:generate
 ```
 
-### `swagger2api init`
+### `swagger2api-v3 init`
 
 初始化配置文件：
 
 ```bash
 # 创建基础配置
-swagger2api init
+swagger2api-v3 init
 
 # 创建示例配置
-swagger2api init --example
+swagger2api-v3 init --example
 
 # 指定输出路径
-swagger2api init -o ./config/swagger.config.ts
+swagger2api-v3 init -o ./config/swagger.config.ts
 ```
 
-### `swagger2api validate`
+### `swagger2api-v3 validate`
 
 验证 Swagger 文档：
 
 ```bash
 # 验证文件
-swagger2api validate -i ./swagger.json
+swagger2api-v3 validate -i ./swagger.json
 
 # 使用配置文件验证
-swagger2api validate -c ./.swagger.config.ts
+swagger2api-v3 validate -c ./.swagger.config.ts
 ```
 
 ## 配置选项
@@ -341,7 +341,7 @@ const config = {
   }
 };
 
-module.exports = config;
+export default config;
 ```
 
 ### 完整配置示例
@@ -362,7 +362,7 @@ const config = {
   }
 };
 
-module.exports = config;
+export default config;
 ```
 
 ## 技术栈
@@ -418,7 +418,7 @@ test/
 ```bash
 # 克隆项目
 git clone <repository-url>
-cd swagger2api
+cd swagger2api-v3
 
 # 安装依赖
 npm install

package/dist/cli/index.js

@@ -42,7 +42,7 @@ const program = new commander_1.Command();
 // 版本信息
 const packageJson = JSON.parse(fs.readFileSync(path.join(__dirname, '../../package.json'), 'utf-8'));
 program
-    .name('swagger2api')
+    .name('swagger2api-v3')
     .description('从 Swagger/OpenAPI 文档生成 TypeScript API 接口')
     .version(packageJson.version);
 // generate 命令
@@ -97,46 +97,58 @@ program
         console.error('❌ 配置文件已存在，使用 --force 参数强制覆盖');
         process.exit(1);
     }
-    const configTemplate = `/**
- * Swagger2API 配置文件
- * 用于配置从 Swagger JSON 生成前端接口的参数
- */
-const config = {
-  // Swagger JSON 文件路径或 URL
-  input: 'https://petstore.swagger.io/v2/swagger.json',
-  
-  // 输出目录
-  output: './src/api',
-  
-  // request 导入路径模板
-  importTemplate: "import { request } from '@/utils/request';",
-  
-  // 生成器类型
-  generator: 'typescript',
-  
-  // 按标签分组生成文件
-  groupByTags: true,
-  
-  // 是否覆盖更新，默认为true。为true时会先删除输出目录下的所有文件
-  overwrite: true,
-  
-  // 接口路径公共前缀，默认为空字符串
-  prefix: '',
-  
-  // 代码格式化命令（可选）
-  lint: 'prettier --write',
-  
-  // 生成选项
-  options: {
-    // 是否添加注释
-    addComments: true
-  }
-};
-
-module.exports = config;
+    // 检测当前项目的模块类型
+    let isESModule = false;
+    const packageJsonPath = path.resolve(process.cwd(), 'package.json');
+    if (fs.existsSync(packageJsonPath)) {
+        try {
+            const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf-8'));
+            isESModule = packageJson.type === 'module';
+        }
+        catch (error) {
+            console.warn('⚠️ 无法读取package.json，使用默认CommonJS格式');
+        }
+    }
+    const configContent = `/**
+ * Swagger2API 配置文件
+ * 用于配置从 Swagger JSON 生成前端接口的参数
+ */
+const config = {
+  // Swagger JSON 文件路径或 URL
+  input: 'https://petstore.swagger.io/v2/swagger.json',
+  
+  // 输出目录
+  output: './src/api',
+  
+  // request 导入路径模板
+  importTemplate: "import { request } from '@/utils/request';",
+  
+  // 生成器类型
+  generator: 'typescript',
+  
+  // 按标签分组生成文件
+  groupByTags: true,
+  
+  // 是否覆盖更新，默认为true。为true时会先删除输出目录下的所有文件
+  overwrite: true,
+  
+  // 接口路径公共前缀，默认为空字符串
+  prefix: '',
+  
+  // 代码格式化命令（可选）
+  lint: 'prettier --write',
+  
+  // 生成选项
+  options: {
+    // 是否添加注释
+    addComments: true
+  }
+};
+
+${isESModule ? 'export default config;' : 'module.exports = config;'}
 `;
     try {
-        fs.writeFileSync(configPath, configTemplate, 'utf-8');
+        fs.writeFileSync(configPath, configContent, 'utf-8');
         console.log('✅ 配置文件已创建:', configPath);
         console.log('💡 请根据需要修改配置文件，然后运行 swagger2api generate');
     }

package/dist/index.js

@@ -100,7 +100,7 @@ class Swagger2API {
         }
         if (errors.length > 0) {
             console.error('❌ 配置验证失败:');
-            errors.forEach(error => console.error(`   - ${error}`));
+            errors.forEach((error) => console.error(`   - ${error}`));
             return false;
         }
         return true;
@@ -115,9 +115,12 @@ async function generateFromConfig(configPath) {
     const configFile = configPath || '.swagger.config.ts';
     const fullPath = path.resolve(process.cwd(), configFile);
     try {
-        // 动态导入配置文件
-        const configModule = await Promise.resolve(`${fullPath}`).then(s => __importStar(require(s)));
-        const config = configModule.default || configModule;
+        let config;
+        // 使用动态import加载配置文件以支持ES模块语法
+        const fileUrl = `file:///${fullPath.replace(/\\/g, '/')}?t=${Date.now()}`;
+        const dynamicImport = new Function('specifier', 'return import(specifier)');
+        const configModule = await dynamicImport(fileUrl);
+        config = configModule.default || configModule;
         const swagger2api = new Swagger2API(config);
         if (!swagger2api.validateConfig()) {
             process.exit(1);
@@ -125,7 +128,8 @@ async function generateFromConfig(configPath) {
         await swagger2api.generate();
     }
     catch (error) {
-        if (error instanceof Error && error.message.includes('Cannot resolve module')) {
+        if (error instanceof Error &&
+            error.message.includes('Cannot resolve module')) {
             console.error(`❌ 找不到配置文件: ${fullPath}`);
             console.error('请确保配置文件存在并且路径正确');
         }

package/package.json

@@ -1,68 +1,68 @@
-{
-  "name": "swagger2api-v3",
-  "version": "1.0.0",
-  "description": "从 Swagger/OpenAPI 文档生成 TypeScript API 接口的命令行工具",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "bin": {
-    "swagger2api-v3": "dist/cli/index.js"
-  },
-  "files": [
-    "dist",
-    "README.md",
-    "package.json"
-  ],
-  "scripts": {
-    "test": "jest",
-    "test:watch": "jest --watch",
-    "test:coverage": "jest --coverage",
-    "test:ci": "jest --ci --coverage --watchAll=false",
-    "build": "tsc",
-    "clean": "rimraf dist",
-    "prebuild": "npm run clean",
-    "start": "node dist/cli/index.js",
-    "dev": "npm run build && npm start",
-    "lint": "prettier --write",
-    "generate": "npm run build && node dist/cli/index.js generate",
-    "init": "npm run build && node dist/cli/index.js init",
-    "validate": "npm run build && node dist/cli/index.js validate",
-    "swagger:generate": "npm run generate",
-    "swagger:run": "npm run generate",
-    "swagger:init": "npm run init",
-    "swagger:validate": "npm run validate"
-  },
-  "keywords": [
-    "swagger",
-    "openapi",
-    "typescript",
-    "api",
-    "generator",
-    "cli",
-    "code-generation"
-  ],
-  "author": "xiaoyang",
-  "license": "MIT",
-  "homepage": "https://github.com/xiaoyang33/swagger2api#readme",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/xiaoyang33/swagger2api.git"
-  },
-  "bugs": {
-    "url": "https://github.com/xiaoyang33/swagger2api/issues"
-  },
-  "packageManager": "pnpm@10.11.0",
-  "type": "commonjs",
-  "devDependencies": {
-    "@types/jest": "^29.5.0",
-    "@types/node": "^24.3.1",
-    "jest": "^29.5.0",
-    "prettier": "^3.6.2",
-    "rimraf": "^6.0.1",
-    "ts-jest": "^29.1.0",
-    "typescript": "^5.9.2"
-  },
-  "dependencies": {
-    "axios": "^1.11.0",
-    "commander": "^12.0.0"
-  }
-}
+{
+  "name": "swagger2api-v3",
+  "version": "1.0.2",
+  "description": "从 Swagger/OpenAPI 文档生成 TypeScript API 接口的命令行工具",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "commonjs",
+  "bin": {
+    "swagger2api-v3": "dist/cli/index.js"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "package.json"
+  ],
+  "scripts": {
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --coverage",
+    "test:ci": "jest --ci --coverage --watchAll=false",
+    "build": "tsc",
+    "clean": "rimraf dist",
+    "prebuild": "npm run clean",
+    "start": "node dist/cli/index.js",
+    "dev": "npm run build && npm start",
+    "lint": "prettier --write",
+    "generate": "npm run build && node dist/cli/index.js generate",
+    "init": "npm run build && node dist/cli/index.js init",
+    "validate": "npm run build && node dist/cli/index.js validate",
+    "swagger:generate": "npm run generate",
+    "swagger:run": "npm run generate",
+    "swagger:init": "npm run init",
+    "swagger:validate": "npm run validate"
+  },
+  "keywords": [
+    "swagger",
+    "openapi",
+    "typescript",
+    "api",
+    "generator",
+    "cli",
+    "code-generation"
+  ],
+  "author": "xiaoyang",
+  "license": "MIT",
+  "homepage": "https://github.com/xiaoyang33/swagger2api-v3#readme",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/xiaoyang33/swagger2api-v3.git"
+  },
+  "bugs": {
+    "url": "https://github.com/xiaoyang33/swagger2api-v3/issues"
+  },
+  "packageManager": "pnpm@10.11.0",
+  "devDependencies": {
+    "@types/jest": "^29.5.0",
+    "@types/node": "^24.3.1",
+    "jest": "^29.5.0",
+    "prettier": "^3.6.2",
+    "rimraf": "^6.0.1",
+    "ts-jest": "^29.1.0",
+    "typescript": "^5.9.2"
+  },
+  "dependencies": {
+    "axios": "^1.11.0",
+    "commander": "^12.0.0"
+  }
+}

package/dist/api/authcontroller/index.d.ts

@@ -1,11 +0,0 @@
-/**
- * AuthController API 接口
- * 此文件由 swagger2api 自动生成，请勿手动修改
- */
-import type { LoginDto, LoginRespDto } from '../types';
-/**
- * 登录
- *
- * @param body
- */
-export declare const authControllerLogin: (data: LoginDto, config?: any) => Promise<import("../../utils/request").IReqBoay<LoginRespDto>>;

package/dist/api/authcontroller/index.js

@@ -1,21 +0,0 @@
-"use strict";
-/**
- * AuthController API 接口
- * 此文件由 swagger2api 自动生成，请勿手动修改
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.authControllerLogin = void 0;
-const request_1 = require("../../utils/request");
-/**
- * 登录
- *
- * @param body
- */
-const authControllerLogin = (data, config) => {
-    return request_1.request.post({
-        url: '/admin/auth/login',
-        data,
-        ...config
-    });
-};
-exports.authControllerLogin = authControllerLogin;

package/dist/api/index.d.ts

@@ -1,8 +0,0 @@
-/**
- * API 入口文件
- * 此文件由 swagger2api 自动生成，请勿手动修改
- */
-export * from './types';
-export * from './authcontroller';
-export * from './usercontroller';
-export * from './menucontroller';

package/dist/api/index.js

@@ -1,24 +0,0 @@
-"use strict";
-/**
- * API 入口文件
- * 此文件由 swagger2api 自动生成，请勿手动修改
- */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./types"), exports);
-__exportStar(require("./authcontroller"), exports);
-__exportStar(require("./usercontroller"), exports);
-__exportStar(require("./menucontroller"), exports);

package/dist/api/menucontroller/index.d.ts

@@ -1,9 +0,0 @@
-/**
- * MenuController API 接口
- * 此文件由 swagger2api 自动生成，请勿手动修改
- */
-import type { MenuListRespDto } from '../types';
-/**
- * 菜单列表
- */
-export declare const menuControllerList: (config?: any) => Promise<import("../../utils/request").IReqBoay<MenuListRespDto>>;

package/dist/api/menucontroller/index.js

@@ -1,18 +0,0 @@
-"use strict";
-/**
- * MenuController API 接口
- * 此文件由 swagger2api 自动生成，请勿手动修改
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.menuControllerList = void 0;
-const request_1 = require("../../utils/request");
-/**
- * 菜单列表
- */
-const menuControllerList = (config) => {
-    return request_1.request.post({
-        url: '/admin/system/menus/list',
-        ...config
-    });
-};
-exports.menuControllerList = menuControllerList;

package/dist/api/types.d.ts

@@ -1,65 +0,0 @@
-/**
- * API 类型定义
- * 此文件由 swagger2api 自动生成，请勿手动修改
- */
-export interface LoginDto {
-    /** 账号 */
-    account: string;
-    /** 密码 */
-    password: string;
-}
-export interface UserInfoRespDto {
-    /** 用户ID */
-    id: string;
-    /** 用户名 */
-    username: string;
-    /** 角色 */
-    roles: string[];
-}
-export interface LoginRespDto {
-    /** 用户信息 */
-    user: any;
-    /** token */
-    token: string;
-}
-export interface UserListDto {
-    /** 页码 */
-    pageNum?: number;
-    /** 每页数量 */
-    pageSize?: number;
-    /** 用户名 */
-    username: string;
-}
-export interface UserListRespDto {
-    /** 列表 */
-    list: UserInfoRespDto[];
-    /** 总条数 */
-    total: number;
-}
-export interface CreateUserDto {
-    /** 用户名 */
-    username: string;
-    /** 密码 */
-    password: string;
-    role: {
-        id?: string;
-    };
-}
-export interface UpdateUserDto {
-    /** 用户名 */
-    username: string;
-}
-export interface MenuInfoRespDto {
-    /** 菜单ID */
-    id: string;
-    /** 菜单名称 */
-    name: string;
-    /** 角色 */
-    roles: string[];
-}
-export interface MenuListRespDto {
-    /** 列表 */
-    list: MenuInfoRespDto[];
-    /** 总条数 */
-    total: number;
-}

package/dist/api/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/usercontroller/index.d.ts

@@ -1,41 +0,0 @@
-/**
- * UserController API 接口
- * 此文件由 swagger2api 自动生成，请勿手动修改
- */
-import type { CreateUserDto, UpdateUserDto, UserListDto, UserListRespDto } from '../types';
-/**
- * 用户列表
- *
- * @param body
- */
-export declare const userControllerList: (data: UserListDto, config?: any) => Promise<import("../../utils/request").IReqBoay<UserListRespDto>>;
-/**
- * 创建用户
- *
- * @param body
- */
-export declare const userControllerCreate: (data: CreateUserDto, config?: any) => Promise<import("../../utils/request").IReqBoay<any>>;
-/**
- * 更新用户
- *
- * @param body
- */
-export declare const userControllerUpdate: (data: UpdateUserDto, config?: any) => Promise<import("../../utils/request").IReqBoay<any>>;
-/**
- *
- * @param pageNum 页码
- * @param pageSize 每页数量
- * @param username 用户名
- */
-export declare const userControllerDetail: (params: {
-    pageNum?: number;
-    pageSize?: number;
-    username: string;
-}, config?: any) => Promise<import("../../utils/request").IReqBoay<any>>;
-/**
- *
- * @param id
- */
-export declare const userControllerDetail1: (params: {
-    id: string;
-}, config?: any) => Promise<import("../../utils/request").IReqBoay<any>>;

package/dist/api/usercontroller/index.js

@@ -1,73 +0,0 @@
-"use strict";
-/**
- * UserController API 接口
- * 此文件由 swagger2api 自动生成，请勿手动修改
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.userControllerDetail1 = exports.userControllerDetail = exports.userControllerUpdate = exports.userControllerCreate = exports.userControllerList = void 0;
-const request_1 = require("../../utils/request");
-/**
- * 用户列表
- *
- * @param body
- */
-const userControllerList = (data, config) => {
-    return request_1.request.post({
-        url: '/admin/system/user/list',
-        data,
-        ...config
-    });
-};
-exports.userControllerList = userControllerList;
-/**
- * 创建用户
- *
- * @param body
- */
-const userControllerCreate = (data, config) => {
-    return request_1.request.post({
-        url: '/admin/system/user/create',
-        data,
-        ...config
-    });
-};
-exports.userControllerCreate = userControllerCreate;
-/**
- * 更新用户
- *
- * @param body
- */
-const userControllerUpdate = (data, config) => {
-    return request_1.request.post({
-        url: '/admin/system/user/update',
-        data,
-        ...config
-    });
-};
-exports.userControllerUpdate = userControllerUpdate;
-/**
- *
- * @param pageNum 页码
- * @param pageSize 每页数量
- * @param username 用户名
- */
-const userControllerDetail = (params, config) => {
-    return request_1.request.get({
-        url: '/admin/system/user/detail',
-        params,
-        ...config
-    });
-};
-exports.userControllerDetail = userControllerDetail;
-/**
- *
- * @param id
- */
-const userControllerDetail1 = (params, config) => {
-    return request_1.request.get({
-        url: '/admin/system/user/detail1',
-        params,
-        ...config
-    });
-};
-exports.userControllerDetail1 = userControllerDetail1;