项目操作

    在新建项目页，填写项目信息：

    项目操作 - 图2

    修改项目

    在项目页点击上方的 设置 Tab 进入项目设置面板，这个面板涵盖了项目的所有配置。

    这里比新建项目页面新增的功能如下：

    点击项目图标，可以修改图标及背景色：

    项目操作 - 图4

    项目迁移

    YApi 中支持项目迁移到不同的分组中。

    迁移权限： 只有管理员和该项目的 owner 有权限对位置进行修改。项目 owner 主要有创建该项目的人、项目中的组长、创建分组的人、分组中的组长。

    Tips: owner 权限判断的优先级是 项目权限 > 分组权限

    该功能在 v1.3.12 版本上线，项目克隆功能可复制项目全部接口到一个新项目，如下图所示,点击红色框里面的 icon 使用。

    操作： 点击下图左上角的复制按钮，在弹窗中写入复制项目名称点击确定就可以完成项目复制

    项目操作 - 图6

    删除项目

    点击下方的删除按钮，输入项目名称进行删除。

    删除项目是高风险操作，因此 YApi 对这个操作进行了特别的约束。

    配置环境

    环境配置 一项可以添加该项目下接口的实际环境，供 接口测试 使用，这里增加了全局 header，可以在项目中设置全局 header 值。在接口运行页面的选择环境 select 中也增加环境配置弹层。

    项目操作 - 图8

    v1.3.21 新增全局变量，用户可以在环境列表中定义全局变量的名称和值, 接口运行或者测试集合里面可以通过 {{ global.err }} 来访问当前环境变量下定义的全局变量

    通过自定义 js 脚本方式改变请求的参数和返回的 response 数据

    请求参数示例

    以 jquery ajax 为例，假设当前的请求参数是

    那么公共变量 context 包含以下属性：

    1. context = {
    2.   pathname: '/api/user',
    3.     id: 1
    4.   },
    5.   requestHeader: {
    6.     xxx: 'xxx'
    7.   },
    8.   method: 'POST',
    9.   requestBody: {
    10.     type:1
    11.   }
    12. }

    在上面的示例请求完成后，假设返回 responseData={a:1},公共变量 context 包含以下属性：

    假设我们需要修改响应数据 responseData a 的值为 2，可以填写如下自定义脚本：

    1. context.responseData.a = 2;

    工具函数

    1. context.utils = {
    2.   _         //underscore 函数,详细 API 查看官网 http://underscorejs.org/
    3.   CryptoJS  // crypto-js（v1.3.21+新增）, 详细用法看 https://github.com/brix/crypto-js
    4.   base64    //转换字符串为 base64 编码
    5.   md5       //转换字符串为 md5 编码
    6.   sha1      //转换字符串为 sha1 编码
    7.   sha224    //转换字符串为 sha224 编码
    8.   sha256    //转换字符串为 sha256 编码
    9.   sha512    //转换字符串为 sha512 编码
    10.   unbase64  //转换 base64 编码为字符串  
    11.   axios     // axios 库，可用于 api 请求，官网 https://github.com/axios/axios
    12. }

    CryptoJS 具体用法

    处理请求参数，或返回数据，可能还会涉及到异步处理，比如 ajax 请求，YApi 在 v1.3.13 版本支持了异步处理。

    1. context.promise = new Promise(function(resolve) {
    2.   var api = context.utils.axios.get('http://yapi.local.qunar.com:3000/api/user/status');
    4.     //...
    5.     console.log(result.data);
    6.     resolve();
    7.   });
    8. });

    promise 还可以来设置接口延迟

    1. context.promise = new Promise(function(resolve) {
    2.   setTimeout(function() {
    3.     console.log('delay 1000ms');
    4.     resolve('ok');
    5.   }, 1000);
    6. });

    使用方法就是在 context 里面添加 promise 参数,并且返回一个 Promise，不熟悉 Promise 的童鞋可以查下相关用法，ajax 请求可以使用 context.utils.axios 库。

    处理完成后，不要忘记 resolve()，不然会一直处于挂起状态

    token 配置

    每个项目都有唯一的标识 token，用户可以使用这个 token 值来请求项目的所有资源数据。目前用到的地方是接口的自动化测试，用户不需要登录就可以访问接口测试结果信息。

    全局mock

    v1.3.21 新增全局 mock 设置，方便用户在项目层面上全局设置公共的mock数据，具体 mock 脚本详细使用方法详见 自定义 Mock 脚本

    可以针对项目自定义 Mock 占位符，具体使用方法如下：

    在接口编辑中使用

    1. {

    Mock 优先级说明

    请求 Mock 数据时，规则匹配优先级：Mock 期望 > 自定义 Mock 脚本 > 项目全局 mock 脚本 > 普通 Mock。