group#

/group/add POST #

描述: 添加项目分组

源码位置: ./server/controllers/group.js:13

参数:

参数名 类型 描述 必选 支持版本
group_name String 项目分组名称，不能为空
group_desc String 项目分组描述
示例：
{
    "errcode": 0,
    "errmsg": "success",
    "data": {
        "_id": 4,
        "group_name": "大数据5",
        "group_desc": "大数据5"
    }
}

/group/list get #

描述: 获取项目分组列表

源码位置: ./server/controllers/group.js:52

示例：
{
    "errcode": 0,
    "errmsg": "success",
    "data": [
        {
            "_id": 1,
            "group_name": "大数据2",
            "group_desc": "大数据2",
            "add_time": 1499244581,
            "up_time": 1499244581
        },
        {
            "_id": 2,
            "group_name": "大数据3",
            "group_desc": "大数据3",
            "add_time": 1499244588,
            "up_time": 1499244588
        },
        {
            "_id": 3,
            "group_name": "大数据4",
            "group_desc": "大数据4",
            "add_time": 1499244652,
            "up_time": 1499244652
        },
        {
            "_id": 4,
            "group_name": "大数据5",
            "group_desc": "大数据5",
            "add_time": 1499328065,
            "up_time": 1499328065
        }
    ]
}

/group/del post #

描述: 删除项目分组

源码位置: ./server/controllers/group.js:72

参数:

参数名 类型 描述 必选 支持版本
id String 项目分组id
示例：
{
    "errcode": 0,
    "errmsg": "success",
    "data": {
        "n": 1,
        "ok": 1
    }
}

/group/up post #

描述: 更新项目分组

源码位置: ./server/controllers/group.js:103

参数:

参数名 类型 描述 必选 支持版本
id String 项目分组id
group_name String 项目分组名称
group_desc String 项目分组描述
示例：
{
    "errcode": 0,
    "errmsg": "success",
    "data": {
        "n": 1,
        "nModified": 1,
        "ok": 1
    }
}

user#

/user/login POST #

描述: 用户登录接口

源码位置: ./server/controllers/user.js:11

参数:

参数名 类型 描述 必选 支持版本
email String email名称，不能为空
password String 密码，不能为空
示例：
{
    "errcode": 0,
    "errmsg": "logout success...",
    "data": {
        "uid": 101,
        "email": "admin@admin.com",
        "add_time": 1499762848,
        "up_time": 1499762848
    }
}

/user/logout GET #

描述: 退出登录接口

源码位置: ./server/controllers/user.js:62

示例：
{
    "errcode": 0,
    "errmsg": "success",
    "data": "ok"
}

/user/reg POST #

描述: 用户注册接口

源码位置: ./server/controllers/user.js:79

参数:

参数名 类型 描述 必选 支持版本
email String email名称，不能为空
password String 密码，不能为空
username String 用户名
示例：
{
    "errcode": 0,
    "errmsg": "logout success...",
    "data": {
        "uid": 101,
        "email": "admin@admin.com",
        "add_time": 1499762848,
        "up_time": 1499762848
    }
}

/user/list GET #

描述: 获取用户列表

源码位置: ./server/controllers/user.js:136

/user/list GET #

描述: 获取用户列表

源码位置: ./server/controllers/user.js:159

参数:

参数名 类型 描述 必选 支持版本
id 用户uid

/user/del POST #

描述: 获取用户列表,只有admin用户才有此权限

源码位置: ./server/controllers/user.js:184

参数:

参数名 类型 描述 必选 支持版本
id 用户uid

project#

/project/add POST #

描述: 添加项目分组

源码位置: ./server/controllers/project.js:12

参数:

参数名 类型 描述 必选 支持版本
name String 项目名称，不能为空
basepath String 项目基本路径，不能为空
prd_host String 项目线上域名，不能为空。可通过配置的域名访问到mock数据
group_id Number 项目分组id，不能为空
desc String 项目描述
示例：
{
    "errcode": 0,
    "errmsg": "success",
    "data": {
        "__v": 0,
        "_id": 8,
        "name": "project_a2",
        "desc": "tttttt",
        "prd_host": "project.a2.cc",
        "basepath": "/a1",
        "uid": 0,
        "group_id": 1,
        "add_time": 1499331387,
        "up_time": 1499331387,
        "members": [
            0
        ]
    }
}

/project/add_member POST #

描述: 添加项目

源码位置: ./server/controllers/project.js:74

参数:

参数名 类型 描述 必选 支持版本
id Number 项目id，不能为空
uid member_uid 项目成员uid,不能为空
示例：
{
    "errcode": 0,
    "errmsg": "success",
    "data": {
        "n": 1,
        "ok": 1
    }
}

/project/del_member POST #

描述: 添加项目

源码位置: ./server/controllers/project.js:106

参数:

参数名 类型 描述 必选 支持版本
id Number 项目id，不能为空
uid member_uid 项目成员uid,不能为空
示例：
{
    "errcode": 0,
    "errmsg": "success",
    "data": {
        "n": 1,
        "ok": 1
    }
}

/project/get GET #

描述: 添加项目

源码位置: ./server/controllers/project.js:138

参数:

参数名 类型 描述 必选 支持版本
id Number 项目id，不能为空
示例：
{
    "errcode": 0,
    "errmsg": "success",
    "data": {
        "_id": 7,
        "name": "project_a1",
        "desc": "tttttt",
        "prd_host": "project.a1.cc",
        "basepath": "/a1",
        "uid": 0,
        "group_id": 1,
        "add_time": 1499331378,
        "up_time": 1499331378,
        "__v": 0,
        "members": [
            0
        ]
    }
}

/project/list GET #

描述: 获取项目列表

源码位置: ./server/controllers/project.js:162

参数:

参数名 类型 描述 必选 支持版本
group_id Number 项目group_id，不能为空
示例：
{
    "errcode": 0,
    "errmsg": "success",
    "data": [
        {
            "_id": 7,
            "name": "project_a1",
            "desc": "tttttt",
            "prd_host": "project.a1.cc",
            "basepath": "/a1",
            "uid": 0,
            "group_id": 1,
            "add_time": 1499331378,
            "up_time": 1499331378,
            "__v": 0,
            "members": [
                0
            ]
        },
        {
            "_id": 8,
            "name": "project_a2",
            "desc": "tttttt",
            "prd_host": "project.a2.cc",
            "basepath": "/a1",
            "uid": 0,
            "group_id": 1,
            "add_time": 1499331387,
            "up_time": 1499331387,
            "__v": 0,
            "members": [
                0
            ]
        }
    ]
}

/project/del POST #

描述: 删除项目

源码位置: ./server/controllers/project.js:186

参数:

参数名 类型 描述 必选 支持版本
id Number 项目id，不能为空
示例：
{
    "errcode": 0,
    "errmsg": "success",
    "data": {
        "n": 1,
        "ok": 1
    }
}

/project/up GET #

描述: 编辑项目

源码位置: ./server/controllers/project.js:219

参数:

参数名 类型 描述 必选 支持版本
id Number 项目id，不能为空
name String 项目名称，不能为空
basepath String 项目基本路径，不能为空
prd_host String 项目线上域名，不能为空。可通过配置的域名访问到mock数据
desc String 项目描述
env Array 项目环境配置
env[].name String 环境名称
env[].host String 环境域名
示例：

//请求示例
{
    "id": 8,
    "env": [{
        "name": "本地开发环境",
        "domain": "http://api.quar.com"
    }],
    "desc": "yapi项目"
}

//返回示例
{
    "errcode": 0,
    "errmsg": "success",
    "data": {
        "n": 1,
        "ok": 1
    }
}

interface#

/interface/add POST #

描述: 添加项目分组

源码位置: ./server/controllers/interface.js:10

参数:

参数名 类型 描述 必选 支持版本
project_id Number 项目id，不能为空
path String 接口请求路径，不能为空
method String 请求方式
req_headers Array 请求的header信息
req_headers[].name String 请求的header信息名
req_headers[].value String 请求的header信息值
req_headers[].required Boolean 是否是必须，默认为否
req_headers[].desc String header描述
req_params_type String 请求参数方式，有["form", "json", "text", "xml"]四种
req_params Mixed 请求参数,如果请求方式是form，参数是Array数组，其他格式请求参数是字符串
req_params[].name String 请求参数名
req_params[].value String 请求参数值，可填写生成规则（mock）。如@email，随机生成一条email
req_params[].type String 请求参数类型，有["text", "file"]两种
res_body_type String 相应信息的数据格式，有["json", "text", "xml"]三种
res_body String 响应信息，可填写任意字符串，如果res_body_type是json,则会调用mock功能
desc String 接口描述
示例：

//请求  /interface/add
//header Content-Type:application/json

{
   "desc": "api",
   "method": "post",
   "path": "/testapi",
   "project_id": 8,
   "req_headers": [
      {
         "key": "h",
         "value": "t"
      }
   ],
   "req_params_type": "form",
   "req_params": [
      {
         "name": "uid",
         "value": 100,
         "type": "text"
      },
     {
         "name": "gid",
         "value": 1001,
         "type": "text"
      }
   ],
   "res_body_type": "json",
   "res_body": "{\"tt\": 222}"
}

//返回结果
{
    "errcode": 0,
    "errmsg": "success",
    "data": {
        "__v": 0,
        "_id": 422,
        "project_id": 8,
        "path": "/testapi",
        "desc": "api",
        "method": "post",
        "req_params_type": "form",
        "res_body": "{\"tt\": 222}",
        "res_body_type": "json",
        "uid": 0,
        "add_time": 1499658569,
        "up_time": 1499658569,
        "req_params_form": [
            {
                "name": "uid",
                "value": "100",
                "_id": "5962f94940a7a5767088fcc0"
            },
            {
                "name": "gid",
                "value": "1001",
                "_id": "5962f94940a7a5767088fcbf"
            }
        ],
        "req_headers": [
            {
                "value": "t",
                "_id": "5962f94940a7a5767088fcc1"
            }
        ]
    }
}

/interface/get GET #

描述: 添加项目分组

源码位置: ./server/controllers/interface.js:77

参数:

参数名 类型 描述 必选 支持版本
id Number 接口id，不能为空
示例：
./api/interface/get.json

/interface/list GET #

描述: 添加项目分组

源码位置: ./server/controllers/interface.js:100

参数:

参数名 类型 描述 必选 支持版本
project_id Number 项目id，不能为空
示例：
./api/interface/list.json

/interface/up POST #

描述: 添加项目分组

源码位置: ./server/controllers/interface.js:124

参数:

参数名 类型 描述 必选 支持版本
id Number 接口id，不能为空
path String 接口请求路径
method String 请求方式
req_headers Array 请求的header信息
req_headers[].name String 请求的header信息名
req_headers[].value String 请求的header信息值
req_headers[].required Boolean 是否是必须，默认为否
req_headers[].desc String header描述
req_params_type String 请求参数方式，有["form", "json", "text", "xml"]四种
req_params Mixed 请求参数,如果请求方式是form，参数是Array数组，其他格式请求参数是字符串
req_params[].name String 请求参数名
req_params[].value String 请求参数值，可填写生成规则（mock）。如@email，随机生成一条email
req_params[].type String 请求参数类型，有["text", "file"]两种
res_body_type String 相应信息的数据格式，有["json", "text", "xml"]三种
res_body String 响应信息，可填写任意字符串，如果res_body_type是json,则会调用mock功能
desc String 接口描述
示例：
{
    "errcode": 0,
    "errmsg": "success",
    "data": {
        "n": 1,
        "nModified": 1,
        "ok": 1
    }
}

/interface/del GET #

描述: 删除接口

源码位置: ./server/controllers/interface.js:189

参数:

参数名 类型 描述 必选 支持版本
id Number 接口id，不能为空
示例：
{
    "errcode": 0,
    "errmsg": "success",
    "data": {
        "n": 1,
        "ok": 1
    }
}