swagger2api-v3 1.1.3 → 1.1.4

package/README.md

@@ -236,7 +236,7 @@ const config = {
 
 ## 🤝 Contributing
 
-Issues and Pull Requests are welcome!
+If you encounter any problems or have suggestions, please feel free to [submit an issue](https://github.com/xiaoyang33/swagger2api-v3/issues) on GitHub. Pull Requests are also welcome!
 
 ## 📄 License
 

package/dist/core/parser.d.ts

@@ -6,6 +6,11 @@ export declare class SwaggerParser {
     private document;
     private config;
     constructor(document: SwaggerDocument, config: SwaggerConfig);
+    /**
+     * 获取所有 schemas (包括 definitions 和 components.schemas)
+     * @returns schemas 对象
+     */
+    private getAllSchemas;
     /**
      * 解析所有API接口
      * @returns API接口信息数组

package/dist/core/parser.js

@@ -10,6 +10,16 @@ class SwaggerParser {
         this.document = document;
         this.config = config;
     }
+    /**
+     * 获取所有 schemas (包括 definitions 和 components.schemas)
+     * @returns schemas 对象
+     */
+    getAllSchemas() {
+        return {
+            ...(this.document.definitions || {}),
+            ...(this.document.components?.schemas || {})
+        };
+    }
     /**
      * 解析所有API接口
      * @returns API接口信息数组
@@ -163,12 +173,14 @@ class SwaggerParser {
     parseTypeDefinition(name, schema) {
         const typeName = (0, utils_1.toPascalCase)(name);
         let definition;
+        // 获取所有 schemas 用于类型解析
+        const allSchemas = this.getAllSchemas();
         if (schema.type === 'object' && schema.properties) {
             // 对象类型
             const properties = Object.entries(schema.properties)
                 .map(([key, value]) => {
                 const optional = schema.required?.includes(key) ? '' : '?';
-                const type = (0, utils_1.swaggerTypeToTsType)(value);
+                const type = (0, utils_1.swaggerTypeToTsType)(value, allSchemas);
                 const comment = value.description
                     ? ` /** ${value.description} */`
                     : '';
@@ -178,9 +190,10 @@ class SwaggerParser {
             definition = `export interface ${typeName} {\n${properties}\n}`;
         }
         else if (schema.type === 'array') {
-            // 数组类型
-            const itemType = (0, utils_1.swaggerTypeToTsType)(schema.items);
-            definition = `export type ${typeName} = ${itemType}[];`;
+            // 数组类型 - 生成指向 items 类型的别名(不带 [])
+            // 在引用时会自动添加 []
+            const itemType = (0, utils_1.swaggerTypeToTsType)(schema.items, allSchemas);
+            definition = `export type ${typeName} = ${itemType};`;
         }
         else if (schema.enum) {
             // 枚举类型

package/dist/utils/index.d.ts

@@ -44,9 +44,10 @@ export declare function removeMethodSuffix(functionName: string, method: string)
 /**
  * 将Swagger类型转换为TypeScript类型
  * @param schema Swagger模式
+ * @param schemas 可选的 schemas 上下文,用于查找被引用的类型定义
  * @returns TypeScript类型字符串
  */
-export declare function swaggerTypeToTsType(schema: any): string;
+export declare function swaggerTypeToTsType(schema: any, schemas?: any): string;
 /**
  * 从Swagger参数生成TypeScript参数类型
  * @param parameters Swagger参数数组

package/dist/utils/index.js

@@ -168,9 +168,10 @@ function removeMethodSuffix(functionName, method) {
 /**
  * 将Swagger类型转换为TypeScript类型
  * @param schema Swagger模式
+ * @param schemas 可选的 schemas 上下文,用于查找被引用的类型定义
  * @returns TypeScript类型字符串
  */
-function swaggerTypeToTsType(schema) {
+function swaggerTypeToTsType(schema, schemas) {
     if (!schema)
         return 'any';
     let baseType = 'any';
@@ -246,6 +247,14 @@ function swaggerTypeToTsType(schema) {
     else if (schema.$ref) {
         const refName = schema.$ref.split('/').pop();
         baseType = sanitizeTypeName(refName || 'any');
+        // 如果提供了 schemas 上下文,检查被引用的 schema 是否是数组类型
+        if (schemas && refName) {
+            const referencedSchema = schemas[refName];
+            if (referencedSchema && referencedSchema.type === 'array') {
+                // 被引用的 schema 是数组类型,添加 []
+                baseType = `${baseType}[]`;
+            }
+        }
     }
     // 处理数组类型
     else if (schema.type === 'array') {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swagger2api-v3",
-  "version": "1.1.3",
+  "version": "1.1.4",
   "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",