YApi

接口管理工具、yapi、y-api

• github
• 官方文档

  安装

软件前提：

• mongodb
• node.js

安装参考

系统准备，不一定需要

# 禁用selinux
vim /etc/selinux/config
将SELINUX=enforcing改为SELINUX=disabled
重启系统
# 关闭防火墙
systemctl stop firewalld
systemctl disable firewalld

基础安装

1. 安装，如果下载github失败，可以手动下载，并安装js包 ： npm install --production
npm install -g yapi-cli
2. 启动，如果端口9090被占用，先修改config.json里的port
yapi server
然后根据提示访问ip:9090 进行配置（默认接口）
账号名："tianyunperfect@gmail.com"，密码："ymfe.org"
3.配置
vim /root/my-yapi/config.json

启动

npm install pm2 -g
# 运行js文件
pm2 start /home/alvin/my-yapi/vendors/server/app.js

升级

cd  {项目目录}
yapi ls //查看版本号列表
yapi update //升级到最新版本
yapi update -v v1.1.0 //升级到指定版本

浏览器插件

使用浏览器插件才能使用接口测试，解决跨域的问题。
下载后，解压，然后在开发模式下安装。

• 3.3版本：yapi-3.3.zip
• 掘金文章参考

  idea插件：EasyYapi

参考：

• EasyYapi
• 配置

基础安装和使用

1、搜索安装：EasyYapi

2、在controller Generate… ，记得给controller、函数、字段都加上注释，否则就会默认英文名字了。
提示：第一次使用时，会要求填写yapi地址、token。

3、查看效果


**

管理项目配置

方式一：默认每个项目的配置都会在idea 的 **Preferences(Settings) > Other Settings > EasyApi 中配置。

方式二：在项目目录下新建：.easy.api.config ，参考上图中的Recommend

#yapi mock
field.mock=#mock
#小数点后两位
float_with_two=@natural(0,10000).@natural(0,100)

配置规则

mock，语法参考 官网示例

java示例

import lombok.AllArgsConstructor;
import lombok.Data;
import java.util.List;
@Data
@AllArgsConstructor
public class PageResult<T> {
    /**
     * 第几页
     *
     * @mock 1
     */
    private Integer currentPage;
    /**
     * 每页数量
     *
     * @mock 10
     */
    private Integer pageSize;
    /**
     * 总数
     *
     * @mock @integer(9,99)
     */
    private Long total;
    private List<T> list;
}