ToB企服应用市场:ToB评测及商务社交产业平台

标题: 基于Swagger自动天生离线API文档(Word、Markdown文档) [打印本页]

作者: 去皮卡多 时间: 2024-8-30 12:17
标题: 基于Swagger自动天生离线API文档(Word、Markdown文档)
在做项目时通常必要给客户提供离线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数据文件

配置文档标题，文档标题用于天生文件名和文档标题，title对应“info.title”，description对应“info.description”

假如只想天生指定模块的API数据，可以在模板设置中选择必要的模块

点击“天生Word离线API文档”按钮即可天生文档

4、打开Document目录，检察刚天生的离线API文档

5、利用TableGo的自界说模板功能还能天生Markdown格式的离线API文档

http://www.tablego.cn
https://gitee.com/vipbooks/TableGo
https://github.com/vipbooks/TableGo

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。

欢迎光临 ToB企服应用市场:ToB评测及商务社交产业平台 (https://dis.qidao123.com/)