zkheartboy / swagger2word

一个Swagger API 文档 转 Word 文档的工具项目

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

使用步骤(Google Chrome):

1、修改 application.yml 文件的 swagger.url 为Swagger Json资源的url地址。
2、服务启动后:访问 http://host(主机):port(端口)/toWord,etc:http://127.0.0.1:8080/toWord
3、可以看到网页上生成的类似 word 文档的页面,右键另存为 xxx.doc 文件即可。

----------------------------------

版本: SwaggerToWord 1.0 (2018-01-18)

简介:一个Swagger API 文档 转 Word 文档的工具项目

备注:项目想法和说明可以参考:http://www.cnblogs.com/jmcui/p/8298823.html

----------------------------------

版本:SwaggerToWord 1.1 (2018-02-11)

更新说明:

已解决:
  • 替换HttpClient工具类以适配更多的Restful服务。
  • 把 json 示例文件替换成 官方的示例文件。
  • 更改写死的模板。让生成的 word 的内容都从Swagger api 中来。
待解决:
  • Http 诸多的参数请求形式,比如 header、body、file等 还没有去处理。
  • 用户自定义的对象还没有适配。

----------------------------------

版本: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模板

About

一个Swagger API 文档 转 Word 文档的工具项目


Languages

Language:Java 84.7%Language:HTML 15.3%