swagger2api-v3 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,30 @@
+import { SwaggerConfig } from './types';
+/**
+ * Swagger2API 主类
+ */
+export declare class Swagger2API {
+    private config;
+    constructor(config: SwaggerConfig);
+    /**
+     * 生成API接口文件
+     */
+    generate(): Promise<void>;
+    /**
+     * 验证配置
+     */
+    validateConfig(): boolean;
+}
+/**
+ * 从配置文件生成API
+ * @param configPath 配置文件路径
+ */
+export declare function generateFromConfig(configPath?: string): Promise<void>;
+/**
+ * 直接使用配置对象生成API
+ * @param config 配置对象
+ */
+export declare function generate(config: SwaggerConfig): Promise<void>;
+export * from './types';
+export { SwaggerParser } from './core/parser';
+export { CodeGenerator } from './core/generator';
+export * from './utils';

package/dist/index.js

@@ -0,0 +1,155 @@
+"use strict";
+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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+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 });
+exports.CodeGenerator = exports.SwaggerParser = exports.Swagger2API = void 0;
+exports.generateFromConfig = generateFromConfig;
+exports.generate = generate;
+const path = __importStar(require("path"));
+const parser_1 = require("./core/parser");
+const generator_1 = require("./core/generator");
+const utils_1 = require("./utils");
+/**
+ * Swagger2API 主类
+ */
+class Swagger2API {
+    constructor(config) {
+        this.config = config;
+    }
+    /**
+     * 生成API接口文件
+     */
+    async generate() {
+        try {
+            console.log('🚀 开始生成API接口文件...');
+            // 1. 加载Swagger文档
+            console.log('📖 加载Swagger文档...');
+            const document = await (0, utils_1.loadSwaggerDocument)(this.config.input);
+            console.log(`✅ 成功加载文档: ${document.info.title} v${document.info.version}`);
+            // 2. 解析文档
+            console.log('🔍 解析API接口...');
+            const parser = new parser_1.SwaggerParser(document, this.config);
+            const apis = parser.parseApis();
+            const types = parser.parseTypes();
+            const groupedApis = parser.groupApisByTags(apis);
+            console.log(`✅ 解析完成: ${apis.length} 个接口, ${types.length} 个类型`);
+            if (this.config.groupByTags) {
+                console.log(`📁 按标签分组: ${groupedApis.size} 个分组`);
+                for (const [tag, tagApis] of groupedApis) {
+                    console.log(`   - ${tag}: ${tagApis.length} 个接口`);
+                }
+            }
+            // 3. 生成代码
+            console.log('⚡ 生成代码文件...');
+            const generator = new generator_1.CodeGenerator(this.config);
+            await generator.generateAll(apis, types, groupedApis);
+            console.log(`✅ 代码生成完成，输出目录: ${this.config.output}`);
+        }
+        catch (error) {
+            console.error('❌ 生成失败:', error);
+            throw error;
+        }
+    }
+    /**
+     * 验证配置
+     */
+    validateConfig() {
+        const errors = [];
+        if (!this.config.input) {
+            errors.push('input 配置项不能为空');
+        }
+        if (!this.config.output) {
+            errors.push('output 配置项不能为空');
+        }
+        if (this.config.generator !== 'typescript') {
+            errors.push('目前只支持 typescript 生成器');
+        }
+        if (errors.length > 0) {
+            console.error('❌ 配置验证失败:');
+            errors.forEach(error => console.error(`   - ${error}`));
+            return false;
+        }
+        return true;
+    }
+}
+exports.Swagger2API = Swagger2API;
+/**
+ * 从配置文件生成API
+ * @param configPath 配置文件路径
+ */
+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;
+        const swagger2api = new Swagger2API(config);
+        if (!swagger2api.validateConfig()) {
+            process.exit(1);
+        }
+        await swagger2api.generate();
+    }
+    catch (error) {
+        if (error instanceof Error && error.message.includes('Cannot resolve module')) {
+            console.error(`❌ 找不到配置文件: ${fullPath}`);
+            console.error('请确保配置文件存在并且路径正确');
+        }
+        else {
+            console.error('❌ 加载配置文件失败:', error);
+        }
+        process.exit(1);
+    }
+}
+/**
+ * 直接使用配置对象生成API
+ * @param config 配置对象
+ */
+async function generate(config) {
+    const swagger2api = new Swagger2API(config);
+    if (!swagger2api.validateConfig()) {
+        throw new Error('配置验证失败');
+    }
+    await swagger2api.generate();
+}
+// 导出类型和工具
+__exportStar(require("./types"), exports);
+var parser_2 = require("./core/parser");
+Object.defineProperty(exports, "SwaggerParser", { enumerable: true, get: function () { return parser_2.SwaggerParser; } });
+var generator_2 = require("./core/generator");
+Object.defineProperty(exports, "CodeGenerator", { enumerable: true, get: function () { return generator_2.CodeGenerator; } });
+__exportStar(require("./utils"), exports);

package/dist/types/index.d.ts

@@ -0,0 +1,363 @@
+/**
+ * Swagger2API 类型定义
+ */
+/**
+ * Swagger配置接口
+ */
+export interface SwaggerConfig {
+    /** Swagger JSON 文件路径或 URL */
+    input: string;
+    /** 输出目录 */
+    output: string;
+    /** 生成器类型 */
+    generator: 'typescript';
+    /** 按 tags 分组生成文件 */
+    groupByTags: boolean;
+    /** 是否覆盖更新，默认为true。为true时会先删除输出目录下的所有文件 */
+    overwrite?: boolean;
+    /** 接口路径公共前缀，默认为空字符串 */
+    prefix?: string;
+    /** 标签分组配置 */
+    tagGrouping?: TagGroupingConfig;
+    /** 生成选项 */
+    options?: GenerationOptions;
+    /** 接口注释配置 */
+    comments?: CommentConfig;
+    /** request 导入路径模板 */
+    importTemplate?: string;
+    /** 格式化代码命令 */
+    lint?: string;
+}
+/**
+ * 标签分组配置
+ */
+export interface TagGroupingConfig {
+    /** 启用标签分组 */
+    enabled: boolean;
+    /** 为每个标签创建子目录 */
+    createSubDirectories: boolean;
+    /** 文件命名方式 */
+    fileNaming: 'tag' | 'kebab-case' | 'camelCase';
+}
+/**
+ * 生成选项
+ */
+export interface GenerationOptions {
+    /** 是否生成数据模型 */
+    generateModels: boolean;
+    /** 是否生成 API 接口 */
+    generateApis: boolean;
+    /** 是否生成入口文件 */
+    generateIndex: boolean;
+    /** 是否使用 Axios */
+    useAxios: boolean;
+    /** 是否添加详细注释 */
+    addComments: boolean;
+    /** 是否格式化代码 */
+    prettify: boolean;
+}
+/**
+ * 注释配置
+ */
+export interface CommentConfig {
+    /** 包含接口描述 */
+    includeDescription: boolean;
+    /** 包含参数信息 */
+    includeParameters: boolean;
+    /** 包含返回值信息 */
+    includeResponses: boolean;
+    /** 包含示例 */
+    includeExamples: boolean;
+}
+/**
+ * Swagger文档结构
+ */
+export interface SwaggerDocument {
+    swagger?: string;
+    openapi?: string;
+    info: SwaggerInfo;
+    host?: string;
+    basePath?: string;
+    schemes?: string[];
+    consumes?: string[];
+    produces?: string[];
+    paths: SwaggerPaths;
+    definitions?: SwaggerDefinitions;
+    components?: SwaggerComponents;
+    tags?: SwaggerTag[];
+}
+/**
+ * Swagger信息
+ */
+export interface SwaggerInfo {
+    title: string;
+    description?: string;
+    version: string;
+    termsOfService?: string;
+    contact?: SwaggerContact;
+    license?: SwaggerLicense;
+}
+/**
+ * Swagger联系信息
+ */
+export interface SwaggerContact {
+    name?: string;
+    url?: string;
+    email?: string;
+}
+/**
+ * Swagger许可证信息
+ */
+export interface SwaggerLicense {
+    name: string;
+    url?: string;
+}
+/**
+ * Swagger路径定义
+ */
+export interface SwaggerPaths {
+    [path: string]: SwaggerPathItem;
+}
+/**
+ * Swagger路径项
+ */
+export interface SwaggerPathItem {
+    get?: SwaggerOperation;
+    post?: SwaggerOperation;
+    put?: SwaggerOperation;
+    delete?: SwaggerOperation;
+    patch?: SwaggerOperation;
+    head?: SwaggerOperation;
+    options?: SwaggerOperation;
+    parameters?: SwaggerParameter[];
+}
+/**
+ * Swagger操作
+ */
+export interface SwaggerOperation {
+    tags?: string[];
+    summary?: string;
+    description?: string;
+    operationId?: string;
+    consumes?: string[];
+    produces?: string[];
+    parameters?: SwaggerParameter[];
+    requestBody?: SwaggerRequestBody;
+    responses: SwaggerResponses;
+    deprecated?: boolean;
+}
+/**
+ * Swagger请求体 (OpenAPI 3.0)
+ */
+export interface SwaggerRequestBody {
+    description?: string;
+    content: {
+        [mediaType: string]: {
+            schema?: SwaggerSchema;
+            example?: any;
+            examples?: {
+                [name: string]: any;
+            };
+        };
+    };
+    required?: boolean;
+}
+/**
+ * Swagger参数
+ */
+export interface SwaggerParameter {
+    name: string;
+    in: 'query' | 'header' | 'path' | 'formData' | 'body';
+    description?: string;
+    required?: boolean;
+    type?: string;
+    format?: string;
+    schema?: SwaggerSchema;
+    items?: SwaggerItems;
+    enum?: any[];
+    default?: any;
+}
+/**
+ * Swagger响应
+ */
+export interface SwaggerResponses {
+    [statusCode: string]: SwaggerResponse;
+}
+/**
+ * Swagger响应项
+ */
+export interface SwaggerResponse {
+    description: string;
+    schema?: SwaggerSchema;
+    headers?: {
+        [name: string]: SwaggerHeader;
+    };
+    examples?: {
+        [mediaType: string]: any;
+    };
+}
+/**
+ * Swagger头部
+ */
+export interface SwaggerHeader {
+    description?: string;
+    type: string;
+    format?: string;
+    items?: SwaggerItems;
+    enum?: any[];
+    default?: any;
+}
+/**
+ * Swagger模式
+ */
+export interface SwaggerSchema {
+    type?: string;
+    format?: string;
+    title?: string;
+    description?: string;
+    default?: any;
+    enum?: any[];
+    items?: SwaggerSchema;
+    properties?: {
+        [name: string]: SwaggerSchema;
+    };
+    additionalProperties?: boolean | SwaggerSchema;
+    required?: string[];
+    allOf?: SwaggerSchema[];
+    oneOf?: SwaggerSchema[];
+    anyOf?: SwaggerSchema[];
+    not?: SwaggerSchema;
+    $ref?: string;
+    example?: any;
+    examples?: any[];
+    discriminator?: string;
+    readOnly?: boolean;
+    writeOnly?: boolean;
+    xml?: SwaggerXml;
+    externalDocs?: SwaggerExternalDocs;
+    nullable?: boolean;
+    deprecated?: boolean;
+}
+/**
+ * Swagger项目
+ */
+export interface SwaggerItems {
+    type?: string;
+    format?: string;
+    items?: SwaggerItems;
+    enum?: any[];
+    default?: any;
+    $ref?: string;
+}
+/**
+ * Swagger定义
+ */
+export interface SwaggerDefinitions {
+    [name: string]: SwaggerSchema;
+}
+/**
+ * Swagger组件 (OpenAPI 3.0)
+ */
+export interface SwaggerComponents {
+    schemas?: {
+        [name: string]: SwaggerSchema;
+    };
+    responses?: {
+        [name: string]: SwaggerResponse;
+    };
+    parameters?: {
+        [name: string]: SwaggerParameter;
+    };
+    examples?: {
+        [name: string]: any;
+    };
+    requestBodies?: {
+        [name: string]: any;
+    };
+    headers?: {
+        [name: string]: SwaggerHeader;
+    };
+    securitySchemes?: {
+        [name: string]: any;
+    };
+    links?: {
+        [name: string]: any;
+    };
+    callbacks?: {
+        [name: string]: any;
+    };
+}
+/**
+ * Swagger标签
+ */
+export interface SwaggerTag {
+    name: string;
+    description?: string;
+    externalDocs?: SwaggerExternalDocs;
+}
+/**
+ * Swagger外部文档
+ */
+export interface SwaggerExternalDocs {
+    description?: string;
+    url: string;
+}
+/**
+ * Swagger XML
+ */
+export interface SwaggerXml {
+    name?: string;
+    namespace?: string;
+    prefix?: string;
+    attribute?: boolean;
+    wrapped?: boolean;
+}
+/**
+ * 生成的API接口信息
+ */
+export interface ApiInfo {
+    /** 接口名称 */
+    name: string;
+    /** HTTP方法 */
+    method: string;
+    /** 接口路径 */
+    path: string;
+    /** 接口描述 */
+    description?: string;
+    /** 标签 */
+    tags: string[];
+    /** 参数 */
+    parameters: ParameterInfo[];
+    /** 响应类型 */
+    responseType: string;
+    /** 请求体类型 */
+    requestBodyType?: string;
+}
+/**
+ * 参数信息
+ */
+export interface ParameterInfo {
+    /** 参数名 */
+    name: string;
+    /** 参数类型 */
+    type: string;
+    /** 参数位置 */
+    in: 'query' | 'header' | 'path' | 'formData' | 'body';
+    /** 是否必需 */
+    required: boolean;
+    /** 参数描述 */
+    description?: string;
+    /** 参数模式 */
+    schema?: SwaggerSchema;
+}
+/**
+ * 生成的类型信息
+ */
+export interface TypeInfo {
+    /** 类型名称 */
+    name: string;
+    /** 类型定义 */
+    definition: string;
+    /** 类型描述 */
+    description?: string;
+}

package/dist/types/index.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * Swagger2API 类型定义
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils/index.d.ts

@@ -0,0 +1,82 @@
+import { SwaggerDocument, SwaggerSchema, SwaggerParameter } from '../types';
+/**
+ * 工具函数集合
+ */
+/**
+ * 将路径转换为小驼峰命名的函数名
+ * @param method HTTP方法
+ * @param path 接口路径
+ * @returns 小驼峰命名的函数名
+ */
+export declare function pathToFunctionName(method: string, path: string): string;
+/**
+ * 将字符串转换为kebab-case
+ * @param str 输入字符串
+ * @returns kebab-case字符串
+ */
+export declare function toKebabCase(str: string): string;
+/**
+ * 将字符串转换为PascalCase
+ * @param str 输入字符串
+ * @returns PascalCase字符串
+ */
+export declare function toPascalCase(str: string): string;
+/**
+ * 将字符串转换为camelCase
+ * @param str 输入字符串
+ * @returns camelCase字符串
+ */
+export declare function toCamelCase(str: string): string;
+/**
+ * 将Swagger类型转换为TypeScript类型
+ * @param schema Swagger模式
+ * @returns TypeScript类型字符串
+ */
+export declare function swaggerTypeToTsType(schema?: SwaggerSchema): string;
+/**
+ * 从Swagger参数生成TypeScript参数类型
+ * @param parameters Swagger参数数组
+ * @returns TypeScript参数类型定义
+ */
+export declare function generateParameterTypes(parameters: SwaggerParameter[]): string;
+/**
+ * 确保目录存在，如果不存在则创建
+ * @param dirPath 目录路径
+ */
+export declare function ensureDirectoryExists(dirPath: string): void;
+/**
+ * 删除目录及其所有内容
+ * @param dirPath 目录路径
+ */
+export declare function removeDirectory(dirPath: string): void;
+/**
+ * 读取Swagger文档
+ * @param input 文件路径或URL
+ * @returns Swagger文档对象
+ */
+export declare function loadSwaggerDocument(input: string): Promise<SwaggerDocument>;
+/**
+ * 写入文件
+ * @param filePath 文件路径
+ * @param content 文件内容
+ */
+export declare function writeFile(filePath: string, content: string): void;
+/**
+ * 生成接口注释
+ * @param operation Swagger操作对象
+ * @param parameters 参数列表
+ * @returns 注释字符串
+ */
+export declare function generateApiComment(operation: any, parameters: SwaggerParameter[]): string;
+/**
+ * 清理文件名，移除非法字符
+ * @param filename 文件名
+ * @returns 清理后的文件名
+ */
+export declare function sanitizeFilename(filename: string): string;
+/**
+ * 获取响应类型
+ * @param responses Swagger响应对象
+ * @returns TypeScript类型字符串
+ */
+export declare function getResponseType(responses: any): string;