# swagger2word

**Repository Path**: endlessvoid/swagger2word

## Basic Information

- **Project Name**: swagger2word
- **Description**: swagger2word
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 3
- **Created**: 2024-09-10
- **Last Updated**: 2025-03-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

### 特性
- 支持swagger2.0、3.0的api转word
- 支持excel模板方式导入方式导出word接口文档，过滤特定url，接口重命名
- 支持docker/k8s方式运行

### 使用步骤（Google Chrome）
#### docker方式

**支持swagger2.0和3.0的api的docker镜像为：haiyanggroup-docker.pkg.coding.net/swagger2word/java/swagger2word:1.5.2**

可通过如下命令直接启动：

> docker run -d haiyanggroup-docker.pkg.coding.net/swagger2word/java/swagger2word:1.5.2 -p10233:10233

启动之后访问：http://127.0.0.1:10233/swagger-ui.html

![新版预览](https://github.com/puhaiyang/swagger2word/blob/master/previewimg/preview1.png)

### excel方式导入导出

下载excel模板：http://localhost:10233/export/excel/template/file/download

![新版预览](https://github.com/puhaiyang/swagger2word/blob/master/previewimg/exceltpl.png)

导出结果为：

![新版预览](https://github.com/puhaiyang/swagger2word/blob/master/previewimg/preview2.png)


#### 原仓库介绍文档
1. 启动工程，访问地址： http://127.0.0.1:8080/swagger-ui.html
2. swagger2Word 提供了多种方式生成 word 文档，可以通过 swagger json 的资源地址，例如：https://petstore.swagger.io/v2/swagger.json ；可以通过上传 json 文件；甚至可以直接输入 json 字符串。  
![Image text](https://github.com/JMCuixy/swagger2word/blob/master/swagger2word.jpg)
3. 生成的 WORD 示例：  
![Image text](https://github.com/JMCuixy/swagger2word/blob/master/demo_word.jpg)

<br>
<br>
<br>
<p>--------------版本迭代历程，感谢各位小伙伴的支持--------------</p>

#### 版本： SwaggerToWord 1.0 （2018-01-18）
1. 一个Swagger API 文档转 Word 文档的工具项目 
2. 项目想法和说明可以参考：[http://www.cnblogs.com/jmcui/p/8298823.html](http://www.cnblogs.com/jmcui/p/8298823.html)

#### 版本：SwaggerToWord 1.1 (2018-02-11)
1. 替换 HttpClient 工具类以适配更多的Restful服务。
2. 把 json 示例文件替换成官方的示例文件。
3. 更改写死的模板。让生成的 word 的内容都从 Swagger api 中来。

#### 版本：SwaggerToWord 1.2 (2018-06-21)
1. 引入了 Spring 的 RestTemplate 取代 HttpClients 以支持更多的 Restful 请求。
2. 命名规范以及增加异常处理，对于无法处理的HTTP请求返回空字符串。
3. 修改之前导入data.josn的方式，变成 restTemplate.getForObject("SwaggerJson的url地址",Map.class) 的动态获取方式。

#### 版本：SwaggerToWord 1.3 (2019-06-12)
1. Spring 框架向 SpringBoot 升级。
2. thymeleaf 取代 jsp模板。

#### 版本：SwaggerToWord 1.4 (2019-08-02)
1. 取消 HttpClient 的请求方式去获得返回值，改由从 Swagger Json 文件中直接读取  
2. 针对 application/json 请求方式的入参做渲染     
3. 对于文字过多导致 HTML table 变形做适配   
4. 真诚感谢 [fpzhan](https://github.com/fpzhan)  的代码贡献。

##### 版本: SwaggerToWord 1.4.1 (2019-09-25)
1. 修复当请求参数为@RequestBody 时，参数类型显示不正确问题。
2. 新增直接从请求路径中获取 Swagger JSON,多项目下API文档生成。
3. 解决中文乱码问题。
4. 真诚感谢 [NealLemon](https://github.com/NealLemon) 的代码贡献。


##### 版本: SwaggerToWord 1.4.2 (2019-10-11)
1. 增加一键下载doc文件文件的方式。
2. 真诚感谢 [benwudan](https://github.com/benwudan) 的想法和代码贡献。

#### 版本：SwaggerToWord 1.5 (2019-12-18)
1. 代码梳理和页面美化。
4. 真诚感谢 [kevin4j](https://github.com/kevin4j)  的代码贡献。