yapi使用

2,117 阅读1分钟

YAPI 介绍

Api 是高效、易用、功能强大的 api 管理平台,旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API,YApi 还为用户提供了优秀的交互体验,开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。

一.安装

1.环境准备

  • nodejs>7.6
  • mongodb>2.6

2.搭建YApi环境

npm install -g yapi-cli --registry https://registry.npm.taobao.org
yapi server

3.平台部署

127.0.0.1:9090

4.启动服务

node vendors/server/app.js

5.使用YAPI

访问 http://localhost:3000 登录账号 admin@admin.com,密码 ymfe.org

6.升级

cd {项目目录}
yapi ls //查看版本列表
yapi upgrade //升级到最新版本
yapi update -V v1.8.0

二.权限

三.建立api

1.建立分组

2.建立项目

3.创建分类

4.创建接口

四.mock

1.普通mock

2.高级mock

全局变量

请求
  • header 请求的HTTP头
  • params 请求参数,包括Body、Query中所有参数
  • cookie 请求带的 Cookies

响应

  • mockJson 接口定义的响应数据Mock模板
  • resHeader 响应的 HTTP头
  • httpCode 响应的 HTTP状态码
  • delay Mock响应延时,单位为ms
  • Random Mock.Random 方法,可以添加自定义占位符
Random.extend({
	constellation: function(date){
    	var constellations = ['白羊''金牛','双子','巨蟹','狮子','处女','天秤','天蝎','射手','摩羯','水瓶','双鱼'];
        return this.pick(constellations);
    }
})
Random.constellation();
Mock.mock('@CONSTELATION');
Mock.mock({constellaion: '@CONSTELLATION'})

五.测试集合

$.{key}.{params|body}.{path}

六.数据导入

自动更新 Swagger 接口数据到 YApi 平台 juejin.cn/post/684490…

七.插件

yapi plugin --name yapi-plugin-auto-test
yapi unplugin --name yapi-plugin-auto-test