SpringBoot使用EasyYapi对代码0侵入实现API接口一键发布到YApi的进阶使用

导读

在前面的小节中，我们介绍了EasyYapi插件的使用，但在实际项目中，如果只是学习到这里是远远不够的，所以这一节的话，我们会解答前一小节遗留的问题：如何设置参数是必需的以及EasyYapi的进阶使用。

一、EasyYapi的注释规范

在前面小节中，我们使用EasyYapi插件可以一键发布到YApi平台，在代码中并没有做任何的配置，那么是EasyYapi是如何工作了？

EasyYapi核心就是抓取到了javadoc的注释。

1.1 类上的注释-分类的信息

在类上面的注释，对应的是YApi的分类的信息，看下如下代码：

/** * * 订单管理(分类名称) * 对订单的基本操作（分类备注/描述） * * @module springboot-vide-demo * @author 悟纤「公众号SpringBoot」 * @date 2022-03-21 * @slogan 大道至简 悟在天成 */@RestController@RequestMapping("/order")public class OrderController {}

说明：

（1）第一行默认是接口的分类名称。

（2）第二行到第一个以@开头的行之前的为分类的描述。

（3）@module用于分类api：

n 导出postman时 , 每个module将作为一个单独的文件夹

n 导出yapi时 , 每个module需要配置相应的token, 即对应一个yapi中的项目

n 默认情况下取当前模块名(单模块项目取项目名)

所以当要导出到YApi的时候，那么@module就是对应的YApi配置的项目。至于说项目的名称叫什么这个不重要，重要的是项目对应的token：

这里我们重新定义了@module为在YApi设置的项目<多音短视频项目>，那么在发布的时候，就需要填写对应的Token（token怎么找，在上一节有说过）：

这样就会发布到<抖音音短视频项目>：

特别说明：没有特殊情况下，这个@module就不要配置了。

另外我们可以看下分类的备注：

1.2 方法上的注释-接口信息

方法上的注释，对应YApi的接口信息，看如下代码：

/** * 测试方法1(api名称) * 这个是测试方法的描述(api描述) * * @param param1 参数1的名称或描述 * @param param2 可以用`@link`来表示当前参数的取值是某个枚举{@link OrderInfo} * @param param3 参数3的名称或描述 * @return 响应描述 */@RequestMapping("/method1")public String method1(long param1,                      @RequestParam  String param2,                      @RequestParam(required = true,defaultValue = "defaultValueOfParam3") String param3){    return "SUCCESS";}

（1）第一行默认是接口的名称。

（2）第二行到第一个以@开头的行之前的为接口的描述。

（3）@param 是参数的信息

（4）@return 是返回的信息

看下对应的YApi的显示：