GitHub |
您所在的位置：网站首页 › swagger导出api文档 › GitHub |
GitHub
使用步骤（Google Chrome）
启动工程，访问地址： http://127.0.0.1:8080/swagger-ui.html
swagger2Word 提供了多种方式生成 word 文档，可以通过 swagger json 的资源地址，例如：https://petstore.swagger.io/v2/swagger.json ；可以通过上传 json 文件；甚至可以直接输入 json 字符串。
生成的 WORD 示例：
--------------版本迭代历程，感谢各位小伙伴的支持-------------- 版本： 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 中来。 版本：SwaggerToWord 1.2 (2018-06-21) 引入了 Spring 的 RestTemplate 取代 HttpClients 以支持更多的 Restful 请求。 命名规范以及增加异常处理，对于无法处理的HTTP请求返回空字符串。 修改之前导入data.josn的方式，变成 restTemplate.getForObject("SwaggerJson的url地址",Map.class) 的动态获取方式。 版本：SwaggerToWord 1.3 (2019-06-12) Spring 框架向 SpringBoot 升级。 thymeleaf 取代 jsp模板。 版本：SwaggerToWord 1.4 (2019-08-02) 取消 HttpClient 的请求方式去获得返回值，改由从 Swagger Json 文件中直接读取 针对 application/json 请求方式的入参做渲染 对于文字过多导致 HTML table 变形做适配 真诚感谢 fpzhan 的代码贡献。 版本: SwaggerToWord 1.4.1 (2019-09-25) 修复当请求参数为@RequestBody 时，参数类型显示不正确问题。 新增直接从请求路径中获取 Swagger JSON,多项目下API文档生成。 解决中文乱码问题。 真诚感谢 NealLemon 的代码贡献。 版本: SwaggerToWord 1.4.2 (2019-10-11) 增加一键下载doc文件文件的方式。 真诚感谢 benwudan 的想法和代码贡献。 版本：SwaggerToWord 1.5 (2019-12-18) 代码梳理和页面美化。 真诚感谢 kevin4j 的代码贡献。 |
【本文地址】