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

news/2024/11/18 16:47:18/文章来源:https://www.cnblogs.com/vipbooks/p/18388547

    在做项目时通常需要给客户提供离线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.hqwc.cn/news/789579.html

如若内容造成侵权/违法违规/事实不符,请联系编程知识网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

一次简单的脱壳

涉及:ESP 定律 例:https://files.cnblogs.com/files/blogs/824994/Magic_Shell.zip?t=1724993084&download=true x64dbg 打开 -> 符号 -> magic_shell.exe下断点F9 运行到 EP单步过 push,能看见 RSP 的值变红根据 ESP 定律,下硬件断点F9 跳转后在最近的 jmp 跳转…

【日记】现在问题变成买哪一台电脑了(344 字)

正文今天领了家电补贴,原本就有换电脑的计划和打算,这下想换电脑的心情越来越强烈了。昨天跟母亲打电话,她跟我聊到有光伏公司跟他们抢生意。虽然这事挺搞,但我还觉得蛮有意思。我万万没想到商战这种事情能发展到我们村里……检查基本已经结束了,没有前阵子那样特别忙碌了…

sata转USB连接硬盘

打开设备管理器,查看硬盘驱动是否为 标准 SATA AHCI 控制器,再查看所添加的硬盘的Bus Number是多少。 然后打开注册表编辑器,进入 计算机\HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\storahci\Parameters\Device,右键点击Device,然后“新建”→”多字符串值”…

是德科技 34465A、34461A系列万用表安捷伦

1. 是德科技生产的台式6位半万用表,原来是安捷伦,改名为是德科技,功能强大,准确度高,主要测量功能如下2. 支持触发测量,不过只有 34465 + DIG选件可以。支持滤波,减少高频噪声 3. 可以设置NPLC,外接电源的一个测量周期,收集这些值进行平均,可以消除电源的影响 4. 支持…

503/504 问题

如果是服务器过载 可以尝试调大tomcat,最大线程数,即可以同时响应的请求8核16G 的服务器一般可以配成2000 下班记得打卡

智慧工厂视频监控解决方案

智能工厂视频监控解决方案以地区生态环境和工厂污染物为关键监控目标。根据线上监控人工智能技术剖析,智能工厂视频监控解决方案24钟头连续不断监控。安全性基本建设已变成当代工厂管理方法的关键构成部分。视频监控系统可以在范围内组装视频监控系统,统一操纵和管理方法出入…

平安校园视频监控方案

平安校园视频监控方案部署一台SuiJi-AI100视频分析服务器,使用校园视频监控智方案能分析仪进行视频取流和视频告警事件的处理,生成告警事件和记录,并进行系统的数据展示和应用,并可联动IP音箱进行告警事件语音广播和实时广播喊话。平安校园视频监控方案部署一台SuiJi-AI100…

智慧校园监控系统解决方案

智慧校园监控系统解决方案适应了社会和教育的信息化要求,同时延伸了教育的办学空间。智慧校园监控系统解决方案 依托智慧校园,构建基于网络的跨越学校、企业和社会的混合式办学模式,是解决中国教育投入不足,提高教育人才培养质量,建立新型安全校园智慧校园体系的途径和方向…

在数小时内构建 CRM:你需要了解的顶级无代码/低代码工具

发现最好的无代码和低代码工具,它们可以帮助你在短短几个小时内建立完全定制的 CRM。或许你在阅读这篇文章时,心里会有一个疑问:在类似 Salesforce 这样强大的传统 CRM 系统已经如此成熟的今天,为什么企业还需要选择用低代码或无代码平台来构建 CRM 呢? 传统CRM 系统确实功…

给poc添加图形化

命令行有时候不够直观,快速给自己的poc添加图形化命令行有时候不够直观 如何快速给自己的poc添加图形化 GUI的库太麻烦了,索性基于gin写了一个ui库 成品展示 运行程序自动打开浏览器运行过程截图:运行完成会有提示(同时会有弹窗)分为两部分输出,fmt.Print输出命令行调试信…

电路基础 ---- 耦合

1 耦合的概念与类型 在模拟电路中,耦合指的是通过某种方式将两个或多个电路部分连接在一起,使得它们之间能够传递信号或电能。耦合的主要目的是在不干扰各电路部分正常工作的情况下,实现信号的有效传输。常见的耦合方式包括电容耦合、电感耦合、变压器耦合、直流耦合和光电耦…

小城酒店也要数智化,火山引擎数据飞轮能带去哪些想象?

通过对数据的充分调用和分析,全面洞察客户需求,并为客户提供精细化、人性化的服务。数智化的智慧酒店将作为地方基础设施建设的重要补充,反哺小城旅游业的发展。更多技术交流、求职机会,欢迎关注字节跳动数据平台微信公众号,回复【1】进入官方交流群 小城旅游,正在成为越…