看啥推荐读物
专栏名称: Java大后端
专注分享Java后端技术,包括Spring Boot、Spring Cloud、MyBatis、MySQL、Dubbo、Zookeeper、ES、K8S、Docker、Redis、MQ、分布式、微服务等主流后端技术。
今天看啥  ›  专栏  ›  Java大后端

干掉 Swagger (丝袜哥),试试这个新工具!

Java大后端  · 公众号  ·  · 2021-03-26 13:30
来源:zhuanlan.zhihu.com/p/148074243?from_voters_page=trueJApiDocs是一个无需额外注解、开箱即用的SpringBoot接口文档生成工具。编写和维护API文档这个事情,对于后端程序员来说,是一件恼人但又不得不做的事情,我们都不喜欢写文档,但除非项目前后端代码都是自己写的,否则API文档将是前后端协作中一个不可或缺的沟通界面。既然不可避免,那就想办法弄个轮子吧。人生苦短,必须偷懒。无图无真相,生成文档的效果如下:img相比Swagger要写一堆注解,Spring RestDocs需要写测试用例,才能生成API文档。JApiDocs 具有无痛集成的特点,你只需花几分钟就能知道它怎么用了。快速开始要使得JApiDcos正确工作,你写的代码应该是像下面的样子的:/** * 用户接口 */@RequestMapping("/api/user/")@RestC ………………………………

原文地址:访问原文地址
快照地址: 访问文章快照