换换 Swagger (丝袜哥)，试试这个新工具！

换换 Swagger (丝袜哥)，试试这个新工具！

架构师编辑部 架构师专栏

大家好，我是磊哥。

今天，磊哥，跟大家介绍一款，跟 Swagger (丝袜哥)类似的接口文档生成工具，相比Swagger需要写一堆注解，JApiDocs 就不需要了，算是无痛集成吧

JApiDocs是一个无需额外注解、开箱即用的SpringBoot接口文档生成工具。

编写和维护API文档这个事情，对于后端程序员来说，是一件恼人但又不得不做的事情，我们都不喜欢写文档，但除非项目前后端代码都是自己写的，否则API文档将是前后端协作中一个不可或缺的沟通界面。既然不可避免，那就想办法弄个轮子吧。人生苦短，必须偷懒。

无图无真相，生成文档的效果如下：

相比Swagger要写一堆注解，Spring RestDocs需要写测试用例，才能生成API文档。JApiDocs 具有无痛集成的特点，你只需花几分钟就能知道它怎么用了。

快速开始

要使得JApiDcos正确工作，你写的代码应该是像下面的样子的：

/** * 用户接口 */@RequestMapping("/api/user/")@RestControllerpublic class UserController { /** * 用户列表 * @param listForm */ @RequestMapping(path = "list", method = {RequestMethod.GET, RequestMethod.POST} ) public ApiResult<PageResult<UserVO>> list(UserListForm listForm){ return null; } /** * 保存用户 * @param userForm */ @PostMapping(path = "save") public ApiResult<UserVO> saveUser(@RequestBody UserForm userForm){ return null; }}

我们给Controller类和方法加上必要的注释，给接口方法返回相关的对象类型。是的，这样JApiDocs就能解析到相关的接口信息了，关注公众号：搜云库技术团队，回复：“面试题”，获取，高清PDF：3625页互联网大厂面试题，就跟我们平时写的代码是差不多的，但要注意，你要通过@param来告诉JApiDocs接口的参数，但在IDE的帮助下，这个工作将是轻松愉悦的：

然后你在任意一个main入口方法执行下面的代码就可以生成文档了：

DocsConfig config = new DocsConfig();config.setProjectPath("your springboot project path"); // 项目根目录config.setProjectName("ProjectName"); // 项目名称config.setApiVersion("V1.0"); // 声明该API的版本config.setDocsPath("your api docs path"); // 生成API 文档所在目录config.setAutoGenerate(Boolean.TRUE); // 配置自动生成Docs.buildHtmlDocs(config); // 执行生成文档

接下来你只管好好写代码，生成Api文档的工作就可以交给JApiDocs了，你不需要再为额外编写和维护文档而烦恼。

功能特性

1、代码即文档

JApiDocs是通过直接解析SpringBoot的源码语法来工作的，所以只要Controller的语法符合一定的代码规范，有合理的注释，就可以直接导出文档。

2、支持导出HTML

便捷的导航和接口查看界面；可本地预览，或者部署到HTTP服务器。推荐部署到服务器，方便前后端展开协作。

3、同步导出客户端Model代码

支持导出Android端的 Java 和iOS端的 Object C Model代码，减少前端程序员的重复编码工作。

4、更多特性

支持接口搜索；支持不同版本和英文文档；自定义扩展等。

简洁的文档

再好用的东西，如果没有文档说明，别人也无从入手。关注公众号：搜云库技术团队，回复：“面试题”，获取，高清PDF：3625页互联网大厂面试题，为了让大家尽快上手，JApiDocs准备了一份极简的文档说明，确保你在几分钟就能用上JApiDocs。花5分钟不到就能认识一个提高工作效率的工具，让你把更多的时间花在更加有价值的事情上，你确认不看一下吗？

仓库地址：https://github.com/YeDaxia/JApiDocs

中文文档：https://japidocs.agilestudio.cn/#/zh-cn/

近期技术热文1、这4种，统计代码执行耗时，才足够优雅2、刚入职，就被各种Code Review，真的有必要吗？3、面试官，欺负人：new Object()到底占用几个字节？4、不要封装工具类了，这款神仙级框架，真好用！第2版：互联网大厂面试题包括 Java 集合、JVM、多线程、并发编程、设计模式、算法调优、Spring全家桶、Java、MyBatis、ZooKeeper、Dubbo、Elasticsearch、Memcached、MongoDB、Redis、MySQL、RabbitMQ、Kafka、Linux、Netty、Tomcat、Python、HTML、CSS、Vue、React、JavaScript、Android 大数据、阿里巴巴等大厂面试题等、等技术栈！阅读原文： 高清 3625页大厂面试题  PDF

阅读原文