EasyYapi安装

1、安装

官方文档：https://easyyapi.com/index.html

2、配置

2.1. 配置文件存放目录

将附件.easy.api.config放置自己idea目录下
JetBrains\IntelliJ IDEA 2021.2.1\easipay_config\easy.api.config

easy.api.config配置文件见百度网盘，easy-api配置文件文件夹。

2.2. idea插件使用本地EasyYapi配置

Markdown的Format type选择ULTIMATE

去除远程配置

加载本地配置

properties.additional=properties.additional=xxx\JetBrains\IntelliJ IDEA 2021.2.1\easipay_config\.easy.api.config

2.3. 代码注释

controller

@RestController
@RequestMapping("/easyYapi")
public class FxEasyYapiController extends BaseController {

    /**
     * 测试
     * @param request 请求参数
     * @return 结果
     */
    @RequestMapping("/test")
    public BaseResponse selectApplyQueryRate(@RequestBody FxEasyYapiRequest request) {
        return BaseResponse.SUCCESS;
    }
}

request

@Data
@ToString
public class FxEasyYapiRequest implements Serializable {
    /**
     * 购汇订单申请主键
     */
    @NotBlank(message = "购汇订单申请主键不能为空")
    @Size(max = 13,message = "购汇订单申请主键超长")
    private String applyId;
    /**
     * 订单号
     */
    @Size(max = 40,message = "订单号超长")
    private String orderNo;
    /**
     * 金额
     */
    @NotNull(message = "金额不能为空")
    @Digits(integer = 10, fraction = 2, message = "金额必须为数字并且只包含两位小数")
    private BigDecimal amount;
    /**
     * 日期 yyyyMMdd
     */
    @Size(min=8,max = 8,message = "日期字段超长，不能超过8位，请重新输入")
    private String Date;
    /**
     * 时间 yyyyMMddHHmmss
     */
    @Size(min=16,max = 16,message = "时间字段超长，不能超过16位，请重新输入")
    private String DateTime;
    /**
     * 状态
     */
    @Digits(integer = 2, fraction = 0, message = "状态超长")
    private Integer status ;
}

对于String类型的长度统一用@Size注解，日期与时间用String接收再对应转换类型。
对于Integer类型、BigDecimal类型的长度用@Digits注解。

2.4. 运行EasyYapi生成Markdown文档

在对应的controller右键选择EasyApi，选择Export Markdown，点击后选择存放路径{$project}/docs/api_doc