无需额外注解的 SpringBoot API文档生成工具
编写和维护API文档这个事情 ， 对于后端程序员来说 ， 是一件恼人但又不得不做的事情 ， 我们都不喜欢写文档 ， 但除非项目前后端代码都是自己写的 ， 否则API文档将是前后端协作中一个不可或缺的沟通界面 。
给大家分享一个无需额外注解、开箱即用的SpringBoot接口文档生成工具 。
无图无真相 ， 生成文档的效果如下：
文章图片
相比Swagger要写一堆注解 ， SpringRestDocs需要写测试用例 ， 才能生成API文档 ， 本工具具有无痛集成的特点 。
快速开始要使得工具正确工作 ， 你写的代码应该是像下面的样子的：
/***用户接口*/@RequestMapping("/api/user/")@RestControllerpublicclassUserController{/***用户列表*@paramlistForm*/@RequestMapping(path="list",method={RequestMethod.GET,RequestMethod.POST})publicApiResult<PageResult>list(UserListFormlistForm){returnnull}/***保存用户*@paramuserForm*/@PostMapping(path="save")publicApiResultsaveUser(@RequestBodyUserFormuserForm){returnnull}}
我们给Controller类和方法加上必要的注释 ， 给接口方法返回相关的对象类型 。 是的 ， 这样JApiDocs就能解析到相关的接口信息了 ， 就跟我们平时写的代码是差不多的 ， 但要注意 ， 你要通过@param来告诉JApiDocs接口的参数 ， 但在IDE的帮助下 ， 这个工作将是轻松愉悦的：
文章图片
然后你在任意一个main入口方法执行下面的代码就可以生成文档了：
DocsConfigconfig=newDocsConfig()config.setProjectPath("yourspringbootprojectpath")//项目根目录config.setProjectName("ProjectName")//项目名称config.setApiVersion("V1.0")//声明该API的版本config.setDocsPath("yourapidocspath")//生成API文档所在目录config.setAutoGenerate(Boolean.TRUE)//配置自动生成Docs.buildHtmlDocs(config)//执行生成文档
接下来你只管好好写代码 ， 生成Api文档的工作就可以交给JApiDocs了 ， 你不需要再为额外编写和维护文档而烦恼 。
功能特性1、代码即文档
JApiDocs是通过直接解析SpringBoot的源码语法来工作的 ， 所以只要Controller的语法符合一定的代码规范 ， 有合理的注释 ， 就可以直接导出文档 。
2、支持导出HTML
便捷的导航和接口查看界面；可本地预览 ， 或者部署到HTTP服务器 。 推荐部署到服务器 ， 方便前后端展开协作 。
3、同步导出客户端Model代码
支持导出Android端的Java和iOS端的ObjectCModel代码 ， 减少前端程序员的重复编码工作 。
4、更多特性
支持接口搜索；支持不同版本和英文文档；自定义扩展等 。
简洁的文档再好用的东西 ， 如果没有文档说明 ， 别人也无从入手 。 为了让大家尽快上手 ， 准备了一份极简的文档说明 ， 确保你在几分钟就能用上
人生苦短 ， 必须偷懒 。
【无需额外注解的 SpringBoot API文档生成工具】花5分钟不到就能认识一个提高工作效率的工具 ， 让你把更多的时间花在更加有价值的事情上 ， 你确认不看一下吗？
推荐阅读
- spring框架之注解的使用
- 音响|严重缺货、额外加价、发货迟缓，小米透明电视这也算量产？
- 芯片|中科院院士突然宣布，无需指望台积电，国产芯片依旧可以超车
- [我的世界 MC 沙盒类游戏 沙盒建造]|有人说《我的世界》游戏低龄化？玩游戏无需太多复杂想法，简单点就好
- 8月24日起上海迪士尼乐园实行预约新规，年卡用户无需提前获取入园名额
- 推荐|美国药管局批准新冠病毒新型检测法，无需提取核酸，留下唾液样本即可
- 辽宁斥资50亿打造景点，无需门票游人爆满，人称东方“威尼斯”
- 阿里巴巴|科技早报 | 特朗普威胁向阿里巴巴等中企施压 软银否认11亿美元额外投资WeWork
- 分辨率|新的超分辨率方法无需不断放大即可显示出精美的细节
- 大侠上车|飞行家的Slogan：美景不用多言，豪华无需转弯