spring-boot-route（六）整合JApiDocs生成接口文档

朴灿烈づ我的快乐病毒、 2021-09-18 05:58 317阅读 0赞

上一篇文章中介绍了使用Swagger生成接口文档，非常方便，功能也十分强大。如果非要说Swaager有什么缺点，想必就是注解写起来比较麻烦。如果我说有一款不用写注解，就可以生成文档的工具，你心动了吗？他就是我们今天的主角——JApiDocs。

下面我们一起来看看如何使用！

## 一、添加依赖 ##

<dependency>
      <groupId>io.github.yedaxia</groupId>
      <artifactId>japidocs</artifactId>
      <version>1.3</version>
    </dependency>

## 二、配置生成参数 ##

我们新建一个项目，然后随便写一个main方法，增加生成文档的配置，然后运行main方法。

DocsConfig config = new DocsConfig();
    config.setProjectPath("F:\\Java旅途\\japi-docs"); // 项目根目录
    config.setProjectName("japi-docs"); // 项目名称
    config.setApiVersion("V1.0");       // 声明该API的版本
    config.setDocsPath("F:\\test"); // 生成API 文档所在目录
    config.setAutoGenerate(Boolean.TRUE);  // 配置自动生成
    Docs.buildHtmlDocs(config); // 执行生成文档

## 三、编码规范 ##

由于JApiDocs是通过解析Java源码来实现的，因此如果要想实现想要的文档，还是需要遵循一定的规范。

### 3.1 类注释、方法注释和属性注释 ###

如果我们想生成类的注释，我们可以直接在类上加注释，也可以通过加@description来生成。

/** * 用户接口类 */
    @RequestMapping("/api/user")
    @RestController
    public class UserController { }
    
    /** * @author Java旅途 * @Description 用户接口类 * @Date 2020-06-15 21:46 */
    @RequestMapping("/api/user")
    @RestController
    public class UserController { }

如果我们想生成方法的注释，只能直接加注释，不能通过加@description来生成。

/** * 查询用户 * @param age 年龄 * @return R<User> */
    @GetMapping("/list")
    public R<User> list(@RequestParam int age){ 
    
        User user = new User("Java旅途", 18);
        return R.ok(user);
    }

JApiDocs可以自动生成实体类，关于实体类属性的注释有三种方式，生成的效果都是一样的，如下：

/** * 用户名称 */
    private String name;
    /** * 用户年龄 */
    private int age;

// 用户名称
    private String name;
    // 用户年龄
    private int age;

private String name;// 用户名称
    private int age;// 用户年龄

他除了支持咱们常用的model外，还支持IOS的model生成效果如下：

![8606dfbf83a399727b3de8941a5a80f5.png][]

![在这里插入图片描述][a731ad0641d6332d489cd1d63c3fcf24.png_pic_center]

### 3.2 请求参数 ###

如果提交的表单是 `application/x-www-form-urlencoded` 类型的`key/value`格式，则我们通过@param注解来获取参数，在参数后面添加注释，示例如下：

/** * @param age 年龄 */
    @GetMapping("/list")
    public R<User> list(@RequestParam int age){ 
        User user = new User("Java旅途", 18);
        return R.ok(user);
    }

生成的文档效果如下：

请求参数

如果提交的表单是 `application/json` 类型的`json`数据格式，如下：

/** * @param user * @return */
    @PostMapping("/add")
    public R<User> add(@RequestBody User user){ 
        return R.ok(user);
    }

生成的文档效果如下：

请求参数

{ 
      "name": "string //用户名称",
      "age": "int //用户年龄"
    }

### 3.3 响应结果 ###

> 我们知道，如果`Controller`声明了`@RestController`，SpringBoot会把返回的对象直接序列成Json数据格式返回给前端。 JApiDocs也利用了这一特性来解析接口返回的结果，但由于JApiDocs是静态解析源码的，因此你要明确指出返回对象的类型信息，JApiDocs支持继承、泛型、循环嵌套等复杂的类解析。

因此我们不需要再写注释，它会根据我们的返回结果进行解析，效果如下：

返回结果：

{ 
      "code": "int",
      "msg": "string",
      "data": { 
        "name": "string //用户名称",
        "age": "int //用户年龄"
      }
    }

最终，我们生成的接口文档，如下：

![在这里插入图片描述][ddc7d8b1c65a9f8ab2f922ff778a087d.png_pic_center]

## 四、高级配置 ##

### 4.1 @ApiDoc ###

如果你不希望把所有的接口都导出，我们可以在配置中设置config.setAutoGenerate(Boolean.FALSE);然后再想要生成的接口上添加@ApiDoc。

@ApiDoc有以下三个属性：

*  result: 这个可以直接声明返回的对象类型，如果你声明了，将会覆盖SpringBoot的返回对象
 *  url: 请求URL，扩展字段，用于支持非SpringBoot项目
 *  method: 请求方法，扩展字段，用于支持非SpringBoot项目

@ApiDoc(result = User.class, url = "/api/user/view", method = "post")

### 4.2 @Ignore ###

如果你不想导出对象里面的某个字段，可以给这个字段加上`@Ignore`注解，这样JApiDocs导出文档的时候就会自动忽略掉了。

public class User { 
        @Ignore
        private int age;
    }

## 五、总结 ##

JApiDocs就介绍到这里了，优势劣势大家很容易就看出来了。几乎不需要注释即可生成接口文档，仅有的几个注释我们也可以通过ide来自动生成。但是JApiDocs不具备Swagger在线调试功能。如果有一天JApiDocs支持在线调试后，那时候肯定会有一大波追随者，毕竟写代码的谁喜欢写多余的注解！

--------------------

#### 本文示例代码已上传至[github][]，点个`star`支持一下！ ####

## Spring Boot系列教程目录 ##

[spring-boot-route（一）Controller接收参数的几种方式][spring-boot-route_Controller]

[spring-boot-route（二）读取配置文件的几种方式][spring-boot-route]

[spring-boot-route（三）实现多文件上传][spring-boot-route 1]

[spring-boot-route（四）全局异常处理][spring-boot-route 2]

[spring-boot-route（五）整合swagger生成接口文档][spring-boot-route_swagger]

[spring-boot-route（六）整合JApiDocs生成接口文档][spring-boot-route_JApiDocs]

[spring-boot-route（七）整合jdbcTemplate操作数据库][spring-boot-route_jdbcTemplate]

[spring-boot-route（八）整合mybatis操作数据库][spring-boot-route_mybatis]

[spring-boot-route（九）整合JPA操作数据库][spring-boot-route_JPA]

[spring-boot-route（十）多数据源切换][spring-boot-route 3]

[spring-boot-route（十一）数据库配置信息加密][spring-boot-route 4]

[spring-boot-route（十二）整合redis做为缓存][spring-boot-route_redis]

[spring-boot-route（十三）整合RabbitMQ][spring-boot-route_RabbitMQ]

[spring-boot-route（十四）整合Kafka][spring-boot-route_Kafka]

[spring-boot-route（十五）整合RocketMQ][spring-boot-route_RocketMQ]

[spring-boot-route（十六）使用logback生产日志文件][spring-boot-route_logback]

[spring-boot-route（十七）使用aop记录操作日志][spring-boot-route_aop]

[spring-boot-route（十八）spring-boot-adtuator监控应用][spring-boot-route_spring-boot-adtuator]

[spring-boot-route（十九）spring-boot-admin监控服务][spring-boot-route_spring-boot-admin]

[spring-boot-route（二十）Spring Task实现简单定时任务][spring-boot-route_Spring Task]

[spring-boot-route（二十一）quartz实现动态定时任务][spring-boot-route_quartz]

[spring-boot-route（二十二）实现邮件发送功能][spring-boot-route 5]

[spring-boot-route（二十三）开发微信公众号][spring-boot-route 6]

[spring-boot-route（二十四）分布式session的一致性处理][spring-boot-route_session]

[spring-boot-route（二十五）两行代码实现国际化][spring-boot-route 7]

[spring-boot-route（二十六）整合webSocket][spring-boot-route_webSocket]

[8606dfbf83a399727b3de8941a5a80f5.png]: /images/20210918/01e0f330d97148c2bfb563ac11a42e61.png
[a731ad0641d6332d489cd1d63c3fcf24.png_pic_center]: /images/20210918/26d7b3b4a56e4b839b1e4b24f9436e6e.png
[ddc7d8b1c65a9f8ab2f922ff778a087d.png_pic_center]: /images/20210918/883bbad2cdd34eecaa6a817d2b144929.png
[github]: https://github.com/binzh303/spring-boot-route
[spring-boot-route_Controller]: https://javatip.cn/archives/66
[spring-boot-route]: https://javatip.cn/archives/72
[spring-boot-route 1]: https://javatip.cn/archives/74
[spring-boot-route 2]: https://javatip.cn/archives/79
[spring-boot-route_swagger]: https://javatip.cn/archives/90
[spring-boot-route_JApiDocs]: https://javatip.cn/archives/91
[spring-boot-route_jdbcTemplate]: https://javatip.cn/archives/92
[spring-boot-route_mybatis]: https://javatip.cn/archives/93
[spring-boot-route_JPA]: https://javatip.cn/archives/94
[spring-boot-route 3]: https://javatip.cn/archives/95
[spring-boot-route 4]: https://javatip.cn/archives/113
[spring-boot-route_redis]: https://javatip.cn/archives/114
[spring-boot-route_RabbitMQ]: https://javatip.cn/archives/115
[spring-boot-route_Kafka]: https://javatip.cn/archives/116
[spring-boot-route_RocketMQ]: https://javatip.cn/archives/117
[spring-boot-route_logback]: https://javatip.cn/archives/118
[spring-boot-route_aop]: https://javatip.cn/archives/119
[spring-boot-route_spring-boot-adtuator]: https://javatip.cn/archives/120
[spring-boot-route_spring-boot-admin]: https://javatip.cn/archives/121
[spring-boot-route_Spring Task]: https://javatip.cn/archives/122
[spring-boot-route_quartz]: https://javatip.cn/archives/123
[spring-boot-route 5]: https://javatip.cn/archives/124
[spring-boot-route 6]: https://javatip.cn/archives/125
[spring-boot-route_session]: https://javatip.cn/archives/284
[spring-boot-route 7]: https://javatip.cn/archives/256
[spring-boot-route_webSocket]: https://javatip.cn/archives/255