在做项目时通常需要给客户提供离线Word的API文档归档，不要跟客户说有Swagger在线API文档，客户不会用也不会去看。只要你有Swagger，TableGo就能自动生成一份漂亮的Word离线API文档给客户，大大提高了写文档的效率，客户看了高兴，大家项目交付的速度也快很多。支持Swagger2和Swagger3 OpenAPI3，使用TableGo的自定义模板功能还能生成Markdown格式的离线API文档。
1、首先打开Swagger找到api-docs的访问地址，这个地址提供了Swagger的文档JSON数据，离线文档就是利用这些JSON数据来生成的
2、打开TableGo，找到并打开生成工具 → 生成自定义文件 → Swagger
3、将api-docs的访问地址填入“在线访问地址”，也可以把api-docs的JSON数据保存到本地JSON文件中，选择离线JSON数据文件
![图片[1]-基于Swagger自动生成离线API文档(Word、Markdown文档) - 玄机博客-玄机博客](https://img2024.cnblogs.com/blog/1032660/202408/1032660-20240830125625238-987830197.png)
配置文档标题，文档标题用于生成文件名和文档标题，title对应“info.title”，description对应“info.description”
![图片[2]-基于Swagger自动生成离线API文档(Word、Markdown文档) - 玄机博客-玄机博客](https://img2024.cnblogs.com/blog/1032660/202408/1032660-20240830125705470-1901261507.png)
如果只想生成指定模块的API数据，可以在模板设置中选择需要的模块
点击“生成Word离线API文档”按钮即可生成文档
4、打开Document目录，查看刚生成的离线API文档
5、使用TableGo的自定义模板功能还能生成Markdown格式的离线API文档
http://www.tablego.cn
https://gitee.com/vipbooks/TableGo
https://github.com/vipbooks/TableGo
1.本站内容仅供参考，不作为任何法律依据。用户在使用本站内容时，应自行判断其真实性、准确性和完整性，并承担相应风险。
2.本站部分内容来源于互联网，仅用于交流学习研究知识，若侵犯了您的合法权益，请及时邮件或站内私信与本站联系，我们将尽快予以处理。
3.本文采用知识共享 署名4.0国际许可协议 [BY-NC-SA] 进行授权
4.根据《计算机软件保护条例》第十七条规定“为了学习和研究软件内含的设计思想和原理，通过安装、显示、传输或者存储软件等方式使用软件的，可以不经软件著作权人许可，不向其支付报酬。”您需知晓本站所有内容资源均来源于网络，仅供用户交流学习与研究使用，版权归属原版权方所有，版权争议与本站无关，用户本人下载后不能用作商业或非法用途，需在24个小时之内从您的电脑中彻底删除上述内容，否则后果均由用户承担责任；如果您访问和下载此文件，表示您同意只将此文件用于参考、学习而非其他用途，否则一切后果请您自行承担，如果您喜欢该程序，请支持正版软件，购买注册，得到更好的正版服务。
5.本站是非经营性个人站点，所有软件信息均来自网络，所有资源仅供学习参考研究目的，并不贩卖软件，不存在任何商业目的及用途
暂无评论内容