基于Swagger自动生成离线API文档(Word、Markdown文档)

410 阅读1分钟

  在做项目时通常需要给客户提供离线Word的API文档归档,不要跟客户说有Swagger在线API文档,客户不会用也不会去看。只要你有Swagger,TableGo就能自动生成一份漂亮的Word离线API文档给客户,大大提高了写文档的效率,客户看了高兴,大家项目交付的速度也快很多。支持Swagger2和Swagger3 OpenAPI3,使用TableGo的自定义模板功能还能生成Markdown格式的离线API文档。

1、首先打开Swagger找到api-docs的访问地址,这个地址提供了Swagger的文档JSON数据,离线文档就是利用这些JSON数据来生成的 10.jpg

11.jpg

2、打开TableGo,找到并打开生成工具 → 生成自定义文件 → Swagger 20.png

21.png

3、将api-docs的访问地址填入“在线访问地址”,也可以把api-docs的JSON数据保存到本地JSON文件中,选择离线JSON数据文件 30.png

31.png

配置文档标题,文档标题用于生成文件名和文档标题,title对应“info.title”,description对应“info.description” 32.png

如果只想生成指定模块的API数据,可以在模板设置中选择需要的模块 33.png

点击“生成Word离线API文档”按钮即可生成文档 34.png

4、打开Document目录,查看刚生成的离线API文档 40.png

41.png

42.png

43.png

44.png

5、使用TableGo的自定义模板功能还能生成Markdown格式的离线API文档 50.png

www.tablego.cn

gitee.com/vipbooks/Ta…

github.com/vipbooks/Ta…