# swaggerGen

**Repository Path**: liu-daniel/swagger-gen

## Basic Information

- **Project Name**: swaggerGen
- **Description**: swagger-typescript-api
根据swagger文档生成对应的typescript接口文档
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-08-01
- **Last Updated**: 2025-08-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# swaggerGen

#### 介绍
swagger-typescript-api
根据swagger文档生成对应的typescript接口文档

#### 软件架构
node


#### 安装教程


#### 使用说明

1.  需要将 swaggerGen文件复制到项目下的 .script文件下
![输入图片说明](assets20250801102520.jpg)

2.  在项目根路径创建 apiGen.config.js 文件， 并按照一下内容，填写自己的文档地址


```
export default {
  swaggerList: [
    {
      title: '数据',
      name: 'data',
      url: 'https://域名/data/v2/api-docs',
    },
    {
      title: '方案',
      name: 'plan',
      url: 'https://域名/plan/v2/api-docs',
    },
  ]
    ...扩展配置
};
```


    
3. 在package.json 文件


 ** 修改package.json 文件中设置 "type": "module"，会将您的项目配置为使用 ES 模块（ESM），
 这意味着您可以使用 import 和 export 语法，而不是 require 和 module.exports。** 


![输入图片说明](image.png)

![输入图片说明](assetsimage.png)


4. 在终端执行 yarn api 命令，生成api接口文档


![输入图片说明](.script/image.png)