EasyYapi安装

浅浅的花香味﹌ 2023-10-12 11:53 15阅读 0赞

## 1、安装 ##

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

![在这里插入图片描述][b1b9deaddd6d4919a25208d4a0155d25.png]

## 2、配置 ##

### 2.1. 配置文件存放目录 ###

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

easy.api.config配置文件见百度网盘，easy-api配置文件文件夹。  
![在这里插入图片描述][4bc78b3c5f854bea8fc416fd46d4c22d.png]

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

Markdown的Format type选择ULTIMATE

![在这里插入图片描述][d1234a08e1804d3d932d6ede6539b4d1.jpeg_pic_center]

去除远程配置  
![在这里插入图片描述][e85d851fcc4241cdbaa0e3b0e4babf7c.png_pic_center]

加载本地配置

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

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

### 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

![在这里插入图片描述][afe56cfb48af4338b46e093b6ae200ff.png]

[b1b9deaddd6d4919a25208d4a0155d25.png]: https://img-blog.csdnimg.cn/b1b9deaddd6d4919a25208d4a0155d25.png
[4bc78b3c5f854bea8fc416fd46d4c22d.png]: https://img-blog.csdnimg.cn/4bc78b3c5f854bea8fc416fd46d4c22d.png
[d1234a08e1804d3d932d6ede6539b4d1.jpeg_pic_center]: https://img-blog.csdnimg.cn/d1234a08e1804d3d932d6ede6539b4d1.jpeg#pic_center
[e85d851fcc4241cdbaa0e3b0e4babf7c.png_pic_center]: https://img-blog.csdnimg.cn/e85d851fcc4241cdbaa0e3b0e4babf7c.png#pic_center
[dc7803c6d0e944cb951a1449af0b39ec.png_pic_center]: https://img-blog.csdnimg.cn/dc7803c6d0e944cb951a1449af0b39ec.png#pic_center
[afe56cfb48af4338b46e093b6ae200ff.png]: https://img-blog.csdnimg.cn/afe56cfb48af4338b46e093b6ae200ff.png