swagger2api-v3 1.1.6 → 1.1.8

package/dist/utils/comment.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateApiComment = generateApiComment;
+/**
+ * 生成接口注释
+ * @param operation Swagger操作对象
+ * @param parameters 参数列表
+ * @returns 注释字符串
+ */
+function generateApiComment(operation, parameters) {
+    const comments = ['/**'];
+    if (operation.summary) {
+        comments.push(` * ${operation.summary}`);
+    }
+    if (operation.description && operation.description !== operation.summary) {
+        comments.push(` * ${operation.description}`);
+    }
+    if (parameters && parameters.length > 0) {
+        const queryParams = parameters.filter((param) => param.in === 'query');
+        const pathParams = parameters.filter((param) => param.in === 'path');
+        const bodyParams = parameters.filter((param) => param.in === 'body');
+        const hasParams = queryParams.length > 0 || pathParams.length > 0;
+        const hasData = bodyParams.length > 0;
+        if (hasParams || hasData) {
+            comments.push(' *');
+            if (hasParams) {
+                const paramDescriptions = [...pathParams, ...queryParams]
+                    .map((param) => param.description || '')
+                    .filter((description) => description)
+                    .join(', ');
+                const description = paramDescriptions || '请求参数';
+                comments.push(` * @param params ${description}`);
+            }
+            if (hasData) {
+                const dataParam = bodyParams[0];
+                const description = dataParam?.description || '请求数据';
+                comments.push(` * @param data ${description}`);
+            }
+            comments.push(` * @param config 可选的请求配置`);
+        }
+    }
+    if (operation.deprecated) {
+        comments.push(' * @deprecated');
+    }
+    comments.push(' */');
+    return comments.join('\n');
+}

package/dist/utils/file.d.ts

@@ -0,0 +1,23 @@
+import { SwaggerDocument } from '../types';
+/**
+ * 确保目录存在，如果不存在则创建
+ * @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;

package/dist/utils/file.js

@@ -0,0 +1,98 @@
+"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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ensureDirectoryExists = ensureDirectoryExists;
+exports.removeDirectory = removeDirectory;
+exports.loadSwaggerDocument = loadSwaggerDocument;
+exports.writeFile = writeFile;
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const axios_1 = __importDefault(require("axios"));
+/**
+ * 确保目录存在，如果不存在则创建
+ * @param dirPath 目录路径
+ */
+function ensureDirectoryExists(dirPath) {
+    if (!fs.existsSync(dirPath)) {
+        fs.mkdirSync(dirPath, { recursive: true });
+    }
+}
+/**
+ * 删除目录及其所有内容
+ * @param dirPath 目录路径
+ */
+function removeDirectory(dirPath) {
+    if (fs.existsSync(dirPath)) {
+        fs.rmSync(dirPath, { recursive: true, force: true });
+    }
+}
+/**
+ * 读取Swagger文档
+ * @param input 文件路径或URL
+ * @returns Swagger文档对象
+ */
+async function loadSwaggerDocument(input) {
+    try {
+        if (input.startsWith('http://') || input.startsWith('https://')) {
+            const { data } = await axios_1.default.get(input);
+            console.log('Loaded from URL:', input);
+            if (data.components?.schemas) {
+                console.log('Schemas count:', Object.keys(data.components.schemas).length);
+            }
+            else {
+                console.log('No schemas in loaded data');
+            }
+            return data;
+        }
+        const content = fs.readFileSync(input, 'utf-8');
+        return JSON.parse(content);
+    }
+    catch (error) {
+        throw new Error(`Failed to load Swagger document from ${input}: ${error}`);
+    }
+}
+/**
+ * 写入文件
+ * @param filePath 文件路径
+ * @param content 文件内容
+ */
+function writeFile(filePath, content) {
+    const dir = path.dirname(filePath);
+    ensureDirectoryExists(dir);
+    fs.writeFileSync(filePath, content, 'utf-8');
+}

package/dist/utils/index.d.ts

@@ -1,99 +1,4 @@
-import { SwaggerDocument, 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;
-/**
- * 从方法名中移除指定的前缀
- * @param methodName 方法名
- * @param prefixes 需要移除的前缀数组
- * @returns 移除前缀后的方法名
- */
-export declare function stripMethodNamePrefixes(methodName: string, prefixes?: string[]): string;
-/**
- * 从函数名中移除 HTTP method 后缀
- * @param functionName 函数名
- * @param method HTTP 方法
- * @returns 移除后缀后的函数名
- */
-export declare function removeMethodSuffix(functionName: string, method: string): string;
-export declare function stripNullFromUnion(typeStr: string): string;
-/**
- * 将Swagger类型转换为TypeScript类型
- * @param schema Swagger模式
- * @param schemas 可选的 schemas 上下文,用于查找被引用的类型定义
- * @returns TypeScript类型字符串
- */
-export declare function swaggerTypeToTsType(schema: any, schemas?: any): 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;
-export declare function sanitizeTypeName(name: string): string;
+export * from './naming';
+export * from './type';
+export * from './file';
+export * from './comment';