Yapi入门笔记

March 13, 2020

字数: 142 · 阅读: 1 分钟 · 访问: -

什么是YAPI

写接口文档的软件, 支持RESTful, Mock假数据, 团队管理协作,非常方便好用.良心之作

内网安装

参考网上的教程吧. mac: https://www.cnblogs.com/yehuisir/p/12190446.html linux; https://www.jianshu.com/p/6c269d00bb38

安装cross-request插件

可以在Yapi运行假数据.

蓝凑云：https://freemt.lanzous.com/i0pDFfo582j

使用mock假数据

{
    "status": 200,//状态码
    "msg": "success",//提示信息
    "data": {
     	"page": 1, //当前页
        "page_count": 10, //一共多少页
        "total_ount": 100, //数据数量
        "list|5-18":[ //生成5到18个子序列
            {
                "id":"@increment", //生成递增主键ID
                "name":"@ctitle(4,6)",//生成中文字符4到6个之间
                "uuid":"@uuid",//生成uuid               
                "created_at":"@date('yyyy-MM-dd')",//生成时期格式
                "status":"@pick(['未认证','已认证','已拒绝','已冻结'])"//从数组里随机选择一项.
            }
        ]
    }
}

mock常用规则

字符串

@cname() 生成名字
@url 生成url
@domain() 生成域名
@email() 生成邮箱
@region() 生成地区，如华中，华北
@province() 生成省份，如北京，山东，湖南省
@city() 生成城市，如玉林市，拉萨， @city(true)
@county() 生成区域，龙亭区
@county(true) 生成完整的区域，如山西省忻州市神池县
@pick([“a”, “e”, “i”, “o”, “u”]) 选择一个元素
@title() 生成标头
@word(），@word(3），@word(3, 5)生成字母，可以指定大小，也可以是范围。
@sentence() @sentence(3) @sentence(3， 5) 生成单词数量同上
@cparagraph()，@cparagraph(2)， @cparagraph(2，5) 生成句子同上
@csentence 中文句子

日期

@date(“yyyy-MM-dd”) 生成日期， “2013-05-07”
@date(“yyyy-MM-dd HH:mm:ss”) “2020-01-02 17:15:04”

数字

@guid() 生成uuid
@id() 生成ID
@id(10) 生成10位的ID
@increment() 递增1，2，3
@increment(100) 递增步长100
@natural(1,100000) 生成自然数
@zip() 生成区号
@integer(1, 10) 生成数字， @integer ， @integer(5）

其它

@boolean() 生成true, false
@rgba() 生成RBG颜色值如"rgb(129, 121, 242)"
@color() 生成颜色值，如"#f2798f"

参考

github https://github.com/YMFE/yapi
官方文档 https://hellosean1025.github.io/yapi/
mockjs规则样例: http://mockjs.com/examples.html