# swagger-plugin

**Repository Path**: xianbingwei/swagger-plugin

## Basic Information

- **Project Name**: swagger-plugin
- **Description**: 一个swagger插件，支持将swagger api生成docx文档
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2022-03-31
- **Last Updated**: 2025-05-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# swagger-plugin

#### 介绍
一个swagger插件，如果你已经使用了swagger，那么它可以用来帮助生成swagger api docx 文档

#### 软件架构
软件架构说明


#### 安装教程

1.  [下载](https://gitee.com/xianbingwei/swagger-plugin/blob/master/swagger-helper.zip)
2.  安装
![输入图片说明](image1.png)
3. 重启idea
4. 更新插件
    下载最新插件后，重新按照2，3步骤安装即可（目前不支持在线更新）
#### 使用说明

1.  选中你需要生成api的controller文件or目录（不选默认当前项目路径）
2.  点击生成
![img.png](img.png)

3.  选则你需要保存api docx的目录
![输入图片说明](use3.png)
4.  生成结果
    新版
![输入图片说明](use4.png)
    旧版
![输入图片说明](res.png)

#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request