当前位置: 首页 > article >正文

基于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


http://www.kler.cn/a/280290.html

相关文章:

  • 【面试】jvm静态变量和局部变量对比
  • 回车键实现登录
  • Openai API + langchain 分析小型pdf文档
  • Tomcat的配置文件中有哪些关键的配置项,它们分别有什么作用?
  • 【搜索引擎】ElasticSearch 7.x版本
  • 电单车TCP通讯协议对接phpworkermanHikversion充电桩上位机通讯协议
  • 【开源分享】在线客服系统PHP源码 带搭建教程
  • 【测试】JMeter从入门到进阶
  • 关于Avalonia程序在Linux上运行画面不显示的问题详解
  • 阅读笔记5:董超底层视觉之美|时空的交错与融合——论视频超分辨率
  • 2024年新算法-基于SBOA-BP混合神经网络的数据预测(Python代码实现)
  • 本地生活服务商系统如何利用本地推获得更多曝光?
  • 排序补充之快排的三路划分法
  • Shell 脚本开发学习
  • SQL函数
  • 5.diff算法和虚拟dom
  • Java接口中的长连接与短连接详解:概念、应用场景及实现
  • RDMA驱动学习(一)- 用户态到内核态的过程
  • 【从问题中去学习k8s】k8s中的常见面试题(夯实理论基础)(十五)
  • Spring Boot 中的 starter 是什么