swagger2api-v3 1.1.3 → 1.1.5

package/README.md

@@ -1,243 +1,230 @@
-# Swagger2API-v3
-
-English | [中文](./README_CN.md)
-
-A powerful command-line tool for automatically generating TypeScript interface code from Swagger (OAS3.0) documentation.
-
-## ✨ Features
-
-- 🚀 **Fast Generation** - Quickly generate TypeScript interface code from Swagger JSON
-- 📁 **Smart Grouping** - Support automatic file grouping by Swagger tags
-- 📝 **Detailed Comments** - Automatically generate detailed comments including descriptions, parameters, and return values
-- 🎨 **Code Formatting** - Support custom formatting commands
-- ⚙️ **Environment Adaptation** - Automatically detect project environment and generate corresponding configuration files
-- 🔧 **CLI Tool** - Provide complete command-line tools
-
-## 📦 Installation
-
-```bash
-# Global installation
-npm install -g swagger2api-v3
-
-# Project dependency
-npm install swagger2api-v3
-```
-
-## 🚀 Quick Start
-
-### 1. Initialize Configuration File
-
-```bash
-npx swagger2api-v3 init
-```
-
-### 2. Configuration File Description
-
-The tool automatically generates configuration files in the corresponding format based on the project environment:
-
-**CommonJS Environment** (`"type": "commonjs"` or not set):
-
-```javascript
-const config = {
-  input: 'https://petstore.swagger.io/v2/swagger.json',
-  output: './src/api',
-  importTemplate: "import { request } from '@/utils/request';",
-  generator: 'typescript',
-  groupByTags: true,
-  overwrite: true,
-  prefix: '',
-  lint: 'prettier --write',
-  options: {
-    addComments: true
-  }
-};
-
-module.exports = config;
-```
-
-**ES Module Environment** (`"type": "module"`):
-
-```javascript
-const config = {
-  // ... same configuration
-};
-
-export default config;
-```
-
-### 3. Generate Interface Code
-
-```bash
-npx swagger2api-v3 generate
-```
-
-## ⚙️ Configuration Options
-
-| Option                   | Type                  | Default        | Description                                                                                                                                                        |
-| ------------------------ | --------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `input`                  | string                | -              | Swagger JSON file path or URL                                                                                                                                      |
-| `output`                 | string                | `'./src/api'`  | Output directory for generated code                                                                                                                                |
-| `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` |
-| `addMethodSuffix`        | boolean               | `true`         | Whether to add HTTP method suffix to generated function names. `true` generates `userListPost`, `false` generates `userList`                                       |
-| `options.addComments`    | boolean               | `true`         | Whether to add detailed comments                                                                                                                                   |
-
-## 📁 Generated File Structure
-
-### Grouped by Tags (Recommended)
-
-```
-src/api/
-├── types.ts           # Data type definitions (TypeScript mode only)
-├── user/              # User-related APIs
-│   └── index.ts
-├── auth/              # Auth-related APIs
-│   └── index.ts
-└── 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
-
-```
-src/api/
-├── types.ts       # Data type definitions
-├── api.ts         # All API interfaces
-└── index.ts       # Entry file
-```
-
-## 💡 Usage Examples
-
-### Generated Type Definitions
-
-```typescript
-// types.ts
-export interface LoginDto {
-  /** Account */
-  account: string;
-  /** Password */
-  password: string;
-}
-
-export interface UserInfo {
-  /** User ID */
-  id: string;
-  /** Username */
-  username: string;
-}
-```
-
-### Generated API Interfaces
-
-```typescript
-// authController/index.ts
-import { request } from '@/utils/request';
-import type { LoginDto, LoginRespDto } from '../types';
-
-/**
- * Login
- * @param data Login parameters
- * @param config Optional request configuration
- */
-export const authControllerLoginPost = (data: LoginDto, config?: any) => {
-  return request.post<LoginRespDto>({
-    url: '/admin/auth/login',
-    data,
-    ...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
-
-```bash
-# Initialize configuration file
-npx swagger2api-v3 init [--force]
-
-# Generate interface code
-npx swagger2api-v3 generate [--config <path>]
-
-# Validate configuration file
-npx swagger2api-v3 validate [--config <path>]
-
-# Show help
-npx swagger2api-v3 --help
-```
-
-## 📝 NPM Scripts
-
-Add to `package.json`:
-
-```json
-{
-  "scripts": {
-    "api:generate": "swagger2api-v3 generate",
-    "api:init": "swagger2api-v3 init",
-    "api:validate": "swagger2api-v3 validate"
-  }
-}
-```
-
-## 🎨 Code Formatting
-
-Support automatic execution of formatting commands after generation:
-
-```javascript
-// In configuration file
-const config = {
-  // ... other configurations
-  lint: 'prettier --write' // or 'eslint --fix', etc.
-};
-```
-
-## 🤝 Contributing
-
-Issues and Pull Requests are welcome!
-
-## 📄 License
-
-MIT License
+# Swagger2API-v3
+
+English | [中文](./README_CN.md)
+
+A powerful command-line tool for automatically generating TypeScript or JavaScript interface code from OpenAPI 3.0 documentation.
+
+## ✨ Features
+
+- 🚀 **Fast Generation** - Quickly generate TypeScript interface code from Swagger JSON
+- 📁 **Smart Grouping** - Support automatic file grouping by Swagger tags
+- 📝 **Detailed Comments** - Automatically generate detailed comments including descriptions, parameters, and return values
+- 🎨 **Code Formatting** - Support custom formatting commands
+- ⚙️ **Environment Adaptation** - Automatically detect project environment and generate corresponding configuration files
+- 🔧 **CLI Tool** - Provide complete command-line tools
+
+## 📦 Installation
+
+```bash
+# Global installation
+npm install -g swagger2api-v3
+
+# Project dependency
+npm install swagger2api-v3
+```
+
+## 🚀 Quick Start
+
+### 1. Initialize Configuration File
+
+```bash
+npx swagger2api-v3 init
+```
+
+### 2. Configuration File Description
+
+The tool generates a `.swagger.config.json` configuration file:
+
+```json
+{
+  "input": "https://petstore.swagger.io/v2/swagger.json",
+  "output": "./src/api",
+  "importTemplate": "import { request } from '@/utils/request';",
+  "generator": "typescript",
+  "requestStyle": "generic",
+  "groupByTags": true,
+  "overwrite": true,
+  "prefix": "",
+  "lint": "prettier --write",
+  "methodNameIgnorePrefix": [],
+  "addMethodSuffix": true,
+  "options": {
+    "addComments": true
+  }
+}
+```
+
+### 3. Generate Interface Code
+
+```bash
+npx swagger2api-v3 generate
+```
+
+## ⚙️ Configuration Options
+
+| Option                   | Type                  | Default        | Description                                                                                                                                                        |
+| ------------------------ | --------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `input`                  | string                | -              | Swagger JSON file path or URL                                                                                                                                      |
+| `output`                 | string                | `'./src/api'`  | Output directory for generated code                                                                                                                                |
+| `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` |
+| `addMethodSuffix`        | boolean               | `true`         | Whether to add HTTP method suffix to generated function names. `true` generates `userListPost`, `false` generates `userList`                                       |
+| `options.addComments`    | boolean               | `true`         | Whether to add detailed comments                                                                                                                                   |
+
+## 📁 Generated File Structure
+
+### Grouped by Tags (Recommended)
+
+```
+src/api/
+├── types.ts           # Data type definitions (TypeScript mode only)
+├── user/              # User-related APIs
+│   └── index.ts
+├── auth/              # Auth-related APIs
+│   └── index.ts
+└── 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
+
+```
+src/api/
+├── types.ts       # Data type definitions
+├── api.ts         # All API interfaces
+└── index.ts       # Entry file
+```
+
+## 💡 Usage Examples
+
+### Generated Type Definitions
+
+```typescript
+// types.ts
+export interface LoginDto {
+  /** Account */
+  account: string;
+  /** Password */
+  password: string;
+}
+
+export interface UserInfo {
+  /** User ID */
+  id: string;
+  /** Username */
+  username: string;
+}
+```
+
+### Generated API Interfaces
+
+```typescript
+// authController/index.ts
+import { request } from '@/utils/request';
+import type { LoginDto, LoginRespDto } from '../types';
+
+/**
+ * Login
+ * @param data Login parameters
+ * @param config Optional request configuration
+ */
+export const authControllerLoginPost = (data: LoginDto, config?: any) => {
+  return request.post<LoginRespDto>({
+    url: '/admin/auth/login',
+    data,
+    ...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
+
+```bash
+# Initialize configuration file
+npx swagger2api-v3 init [--force]
+
+# Generate interface code
+npx swagger2api-v3 generate [--config <path>]
+
+# Validate configuration file
+npx swagger2api-v3 validate [--config <path>]
+
+# Show help
+npx swagger2api-v3 --help
+```
+
+## 📝 NPM Scripts
+
+Add to `package.json`:
+
+```json
+{
+  "scripts": {
+    "api:generate": "swagger2api-v3 generate",
+    "api:init": "swagger2api-v3 init",
+    "api:validate": "swagger2api-v3 validate"
+  }
+}
+```
+
+## 🎨 Code Formatting
+
+Support automatic execution of formatting commands after generation:
+
+```json
+{
+  "lint": "prettier --write"
+}
+```
+
+## 🤝 Contributing
+
+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
+
+MIT License

package/dist/cli/index.js

@@ -50,7 +50,7 @@ program
     .command('generate')
     .alias('gen')
     .description('根据配置文件生成 API 接口')
-    .option('-c, --config <path>', '配置文件路径', '.swagger.config.ts')
+    .option('-c, --config <path>', '配置文件路径', '.swagger.config.json')
     .option('-i, --input <path>', 'Swagger JSON 文件路径或 URL')
     .option('-o, --output <path>', '输出目录')
     .option('--no-types', '不生成类型文件')
@@ -92,79 +92,31 @@ program
     .description('初始化配置文件')
     .option('-f, --force', '强制覆盖已存在的配置文件')
     .action(async (options) => {
-    const configPath = path.resolve(process.cwd(), '.swagger.config.ts');
+    const configPath = path.resolve(process.cwd(), '.swagger.config.json');
     if (fs.existsSync(configPath) && !options.force) {
         console.error('❌ 配置文件已存在，使用 --force 参数强制覆盖');
         process.exit(1);
     }
-    // 检测当前项目的模块类型
-    let isESModule = true; // 默认使用 ES Module
-    const packageJsonPath = path.resolve(process.cwd(), 'package.json');
-    if (fs.existsSync(packageJsonPath)) {
-        try {
-            const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf-8'));
-            // 只有明确设置为 commonjs 时才使用 CommonJS，否则默认使用 ES Module
-            isESModule = packageJson.type !== 'commonjs';
+    const config = {
+        input: 'http://localhost:3000/admin/docs/json',
+        output: './src/api',
+        importTemplate: "import { request } from '@/utils/request';",
+        generator: 'typescript',
+        requestStyle: 'generic',
+        groupByTags: true,
+        overwrite: true,
+        prefix: '',
+        lint: 'prettier --write',
+        methodNameIgnorePrefix: [],
+        addMethodSuffix: true,
+        options: {
+            addComments: true
         }
-        catch (error) {
-            console.warn('⚠️ 无法读取package.json，使用默认ES Module格式');
-        }
-    }
-    const configContent = `/**
- * Swagger2API 配置文件
- * 用于配置从 Swagger JSON 生成前端接口的参数
- */
-const config = {
-  // Swagger JSON 文件路径或 URL
-  input: 'http://localhost:3000/admin/docs/json',
-  
-  // 输出目录
-  output: './src/api',
-  
-  // request 导入路径模板
-  importTemplate: "import { request } from '@/utils/request';",
-  
-  // 生成器类型
-  generator: 'typescript', // 可选 'javascript'（JS 模式输出 .js 文件且不生成类型文件）
-  
-  // 请求调用风格：'method' 使用 request.get/post；'generic' 使用 request({ method })
-  requestStyle: 'generic',
-  
-  // 按标签分组生成文件
-  groupByTags: true,
-  
-  // 是否覆盖更新，默认为true。为true时会先删除输出目录下的所有文件
-  overwrite: true,
-  
-  // 接口路径公共前缀，默认为空字符串
-  prefix: '',
-  
-  // 代码格式化命令（可选）
-  lint: 'prettier --write',
-  
-  // 生成方法名时需要忽略的前缀（可选）
-  // 例如：配置 ['api', 'auth'] 后，apiGetName 会变成 getName，authUserInfo 会变成 userInfo
-  // 如果方法名是 apiAuthGetName，会依次移除所有匹配的前缀，最终变成 getName
-  methodNameIgnorePrefix: [],
-  
-  // 是否在生成的方法名中添加 HTTP method 后缀，默认为 true
-  // true: userListPost, userDetailGet
-  // false: userList, userDetail
-  addMethodSuffix: true,
-  
-  // 生成选项
-  options: {
-    // 是否添加注释
-    addComments: true
-  }
-};
-
-${isESModule ? 'export default config;' : 'module.exports = config;'}
-`;
+    };
     try {
-        fs.writeFileSync(configPath, configContent, 'utf-8');
+        fs.writeFileSync(configPath, JSON.stringify(config, null, 2), 'utf-8');
         console.log('✅ 配置文件已创建:', configPath);
-        console.log('💡 请根据需要修改配置文件，然后运行 swagger2api generate');
+        console.log('💡 请根据需要修改配置文件，然后运行 swagger2api-v3 generate');
     }
     catch (error) {
         console.error('❌ 创建配置文件失败:', error);
@@ -175,12 +127,16 @@ ${isESModule ? 'export default config;' : 'module.exports = config;'}
 program
     .command('validate')
     .description('验证配置文件')
-    .option('-c, --config <path>', '配置文件路径', '.swagger.config.ts')
+    .option('-c, --config <path>', '配置文件路径', '.swagger.config.json')
     .action(async (options) => {
     const configPath = path.resolve(process.cwd(), options.config);
     try {
-        const configModule = await Promise.resolve(`${configPath}`).then(s => __importStar(require(s)));
-        const config = configModule.default || configModule;
+        if (!fs.existsSync(configPath)) {
+            console.error(`❌ 找不到配置文件: ${configPath}`);
+            process.exit(1);
+        }
+        const configContent = fs.readFileSync(configPath, 'utf-8');
+        const config = JSON.parse(configContent);
         const { Swagger2API } = await Promise.resolve().then(() => __importStar(require('../index')));
         const swagger2api = new Swagger2API(config);
         if (swagger2api.validateConfig()) {
@@ -200,7 +156,13 @@ program
         }
     }
     catch (error) {
-        console.error('❌ 配置文件验证失败:', error);
+        if (error instanceof SyntaxError) {
+            console.error(`❌ 配置文件 JSON 格式错误: ${configPath}`);
+            console.error('错误详情:', error.message);
+        }
+        else {
+            console.error('❌ 配置文件验证失败:', error);
+        }
         process.exit(1);
     }
 });
@@ -208,7 +170,7 @@ program
 program
     .command('run')
     .description('运行生成器（generate 命令的别名）')
-    .option('-c, --config <path>', '配置文件路径', '.swagger.config.ts')
+    .option('-c, --config <path>', '配置文件路径', '.swagger.config.json')
     .action(async (options) => {
     try {
         await (0, index_1.generateFromConfig)(options.config);

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

@@ -40,6 +40,7 @@ exports.CodeGenerator = exports.SwaggerParser = exports.Swagger2API = void 0;
 exports.generateFromConfig = generateFromConfig;
 exports.generate = generate;
 const path = __importStar(require("path"));
+const fs = __importStar(require("fs"));
 const parser_1 = require("./core/parser");
 const generator_1 = require("./core/generator");
 const utils_1 = require("./utils");
@@ -119,15 +120,19 @@ exports.Swagger2API = Swagger2API;
  * @param configPath 配置文件路径
  */
 async function generateFromConfig(configPath) {
-    const configFile = configPath || '.swagger.config.ts';
+    const configFile = configPath || '.swagger.config.json';
     const fullPath = path.resolve(process.cwd(), configFile);
     try {
         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;
+        // 读取并解析 JSON 配置文件
+        if (!fs.existsSync(fullPath)) {
+            console.error(`❌ 找不到配置文件: ${fullPath}`);
+            console.error('请确保配置文件存在并且路径正确');
+            console.error('提示: 运行 swagger2api-v3 init 来创建配置文件');
+            process.exit(1);
+        }
+        const configContent = fs.readFileSync(fullPath, 'utf-8');
+        config = JSON.parse(configContent);
         const swagger2api = new Swagger2API(config);
         if (!swagger2api.validateConfig()) {
             process.exit(1);
@@ -135,10 +140,10 @@ async function generateFromConfig(configPath) {
         await swagger2api.generate();
     }
     catch (error) {
-        if (error instanceof Error &&
-            error.message.includes('Cannot resolve module')) {
-            console.error(`❌ 找不到配置文件: ${fullPath}`);
-            console.error('请确保配置文件存在并且路径正确');
+        if (error instanceof SyntaxError) {
+            console.error(`❌ 配置文件 JSON 格式错误: ${fullPath}`);
+            console.error('请检查 JSON 语法是否正确');
+            console.error('错误详情:', error.message);
         }
         else {
             console.error('❌ 加载配置文件失败:', error);

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