首页 > 其他分享 >基于Swagger自动生成离线API文档(Word、Markdown文档)

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

时间:2024-08-30 13:04:24浏览次数:10  
标签:Markdown 离线 生成 TableGo API 文档 Swagger

    在做项目时通常需要给客户提供离线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

标签:Markdown,离线,生成,TableGo,API,文档,Swagger
From: https://www.cnblogs.com/vipbooks/p/18388547

相关文章

  • BIM交流文档
    要把我们国家不透明的建筑业系统与工信部与国机集团与水利电力等等国家部门公司整合改造。合同、施工方法等等各类信息检索管理。感觉revit照明的有些API源自unity的API,或者引用自Un,有待查证。还有faberaciton源自cad的一个插件,2016版开始集成到revit里,就是创建零件相关功能,......
  • 基于SpringBoot+Vue足球俱乐部管理后台的设计和实现(源码+文档+部署讲解)
    博主介绍:全网粉丝10W+,CSDN博客专家、全栈领域优质创作者,3年JAVA全栈开发经验,专注JAVA技术、系统定制、远程指导,致力于企业数字化转型。研究方向:SpringBoot、Vue.JS、MyBatisPlus、Redis、SpringSecurity、MySQL、小程序、Android、Uniapp等。博主说明:本文项目编号......
  • 基于SpringBoot+Vue师生健康管理系统的设计和实现(源码+文档+部署讲解)
    博主介绍:全网粉丝10W+,CSDN博客专家、全栈领域优质创作者,3年JAVA全栈开发经验,专注JAVA技术、系统定制、远程指导,致力于企业数字化转型。研究方向:SpringBoot、Vue.JS、MyBatisPlus、Redis、SpringSecurity、MySQL、小程序、Android、Uniapp等。博主说明:本文项目编号......
  • Markdown学习
    Markdown学习向AI助手提问:作为计算机技术专家、人工智能技术专家,网络空间安全专家,密码学专家,密码技术专家,请您:深入浅出的讲解一下Mardown,Markdown的详细语法推荐至少两款线上工具,至少两种线下工具讲解Markdown的高级用法,包括插入数学公式、绘图、制作PPT,格式转换讲解Markd......
  • 大学生班级|基于SprinBoot+vue的大学生班级管理系统(源码+数据库+文档)
    大学生班级管理系统基于SprinBoot+vue的大学生班级管理系统一、前言二、系统设计三、系统功能设计 系统功能实现后台模块实现管理员功能实现教师功能实现学生功能实现四、数据库设计 五、核心代码 六、论文参考七、最新计算机毕设选题推荐八、源码获取:博......
  • 为何选择合适的文档管理系统至关重要?
    国内外主流的10款文档管理系统对比:1.PingCode;2.Worktile;3.飞书文档;4.石墨文档;5.语雀;6.GoogleDocs;7.DropboxBusiness;8.Confluence;9.MicrosoftOneDrive;10.Box。在当今快速发展的商业环境中,众多企业面临的一个主要挑战是如何有效管理日益增长的文件和数据。传统的文件管理方......
  • 1-1 Markdown学习
    1-1Markdown学习任务详情你熟悉Markdown格式吗?选择自己熟悉的AI平台,把下面的提示词发给ta:""作为计算机技术专家、人工智能技术专家,网络空间安全专家,密码学专家,密码技术专家,请您:深入浅出的讲解一下Mardown,Markdown的详细语法推荐至少两款线上工具,至少两种线下工具讲解Mar......
  • 基于Springboot公寓电费管理系统的设计与实现(源码+LW+调试文档)
     目录:程序功能截图:程序部分代码参考:数据库sql:程序技术介绍:后端springboot介绍:mysql介绍:程序论文:​选择我的理由:程序获取:......
  • 基于SpringBoot大学生征兵入伍管理系统的设计与实现(源码+LW+调试文档)
     目录:程序功能截图:程序部分代码参考:数据库sql:程序技术介绍:后端springboot介绍:mysql介绍:程序论文:​选择我的理由:程序获取:......
  • java毕业设计-基于springboot+vue的高校自习室预约系统设计和实现,基于springboot+vue
    文章目录前言演示视频项目架构和内容获取(文末获取)项目相关文件系统功能部分实现截图架构设计MVC的设计模式基于B/S的架构技术栈具体功能模块设计系统需求分析可行性分析系统测试为什么我?关于我我自己的网站项目开发案例前言博主介绍:✌️码农一枚,专注于大学生项目......