# swagger2-doc-parser

**Repository Path**: swagger2-doc/swagger2-doc-parser

## Basic Information

- **Project Name**: swagger2-doc-parser
- **Description**: 解析swagger2、swagger3文档的JSON文件，转换为特定语言(ts、js和dart)接口代码。
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 6
- **Forks**: 0
- **Created**: 2022-03-30
- **Last Updated**: 2025-05-09

## Categories & Tags

**Categories**: api-gateway

**Tags**: None

## README

## swagger-doc-parser

解析swagger2文档的JSON文件，转换为特定语言(ts、js和dart)接口代码。

#### 如何安装？

```bash
git clone https://gitee.com/swagger2-doc/swagger2-doc-parser
cd swagger2-doc-parser
npm install
npm link
```

#### 如何使用？

```bash
swagger2-doc-parser
Usage: swagger2-doc-parser [options] [command]

Options:
  -V, --version          output the version number
  -h, --help             display help for command

Commands:
  fetch [options] <url>  fetch api docs from swagger ui, eg: swagger2-doc-parser fetch http://localhost:8083/v1/v2/api-docs
  gen [options]          gen dart code from api docs, eg: swagger2-doc-parser gen -c ./config.js -o ./lib/controllers
  help [command]         display help for command
```


#### 示例项目【参考借鉴】

1. java-server // TODO
2. flutter-client // TODO
3. react-js-client // TODO
4. react-ts-client // TODO
5. vue-js-client // TODO
6. vue-ts-client // TODO

#### 联系方式【参与讨论】

1. 微信群 添加WX `liuhong17happy`，备注“Swagger2"，同意后邀请进群

#### 赞助

如果你觉得本项目对你有用，提提意见或者微不足道的赞助，都是对项目作者最大的支持。

| 微信支付                                                                                                                                                | 支付宝支付                                         |
| ------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- |
| ![1648617667411.png](./image/README/1648617667411.png "微信支付") | ![1648617844315.png](./image/README/1648617844315.png) |