group#

/group/get GET #

描述: 添加项目分组

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

参数:

参数名 类型 描述 必选 支持版本
id String 项目分组ID

/group/add POST #

描述: 添加项目分组

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

参数:

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

/group/add_member POST #

描述: 添加项目分组成员

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

参数:

参数名 类型 描述 必选 支持版本
id String 项目分组id
member_uid String 项目分组成员uid
role String 成员角色，owner or dev

/group/change_member_role POST #

描述: 修改项目分组成员角色

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

参数:

参数名 类型 描述 必选 支持版本
id String 项目分组id
member_uid String 项目分组成员uid
role String 权限 ['owner'|'dev']

/group/get_member_list GET #

描述: 获取所有项目成员

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

参数:

参数名 类型 描述 必选 支持版本
id String 项目分组id

/group/del_member POST #

描述: 删除项目成员

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

参数:

参数名 类型 描述 必选 支持版本
id String 项目分组id
member_uid String 项目分组成员uid

/group/list get #

描述: 获取项目分组列表

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

示例：
{
    "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:290

参数:

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

/group/up post #

描述: 更新项目分组

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

参数:

参数名 类型 描述 必选 支持版本
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:18

参数:

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

/user/logout GET #

描述: 退出登录接口

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

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

/user/change_password POST #

描述: 修改用户密码

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

参数:

参数名 类型 描述 必选 支持版本
uid Number 用户ID
old_password Number 旧密码, 非admin用户必须传
password Number 新密码
示例：
{
    "errcode": 0,
    "errmsg": "success",
    "data": {
        "n": 1,
        "nModified": 1,
        "ok": 1
    }
}

/user/reg POST #

描述: 用户注册接口

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

参数:

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

/user/list GET #

描述: 获取用户列表

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

参数:

参数名 类型 描述 必选 支持版本
page Number 分页页码
limit Number 分页大小,默认为10条

/user/find GET #

描述: 获取用户个人信息

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

参数:

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

/user/del POST #

描述: 删除用户,只有admin用户才有此权限

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

参数:

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

/user/update POST #

描述: 更新用户个人信息

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

参数:

参数名 类型 描述 必选 支持版本
uid 用户uid
role 用户角色,只有管理员有权限修改
username String
email String

/user/upload_avatar POST #

描述: 上传用户头像

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

参数:

参数名 类型 描述 必选 支持版本
basecode * base64编码，通过h5 api传给后端

/user/avatar GET #

描述: 根据用户uid头像

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

参数:

参数名 类型 描述 必选 支持版本
uid *

/user/search GET #

描述: 模糊搜索用户名或者email

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

参数:

参数名 类型 描述 必选 支持版本
q String
示例：
{
    "errcode": 0,
    "errmsg": "ok",
    "data": [
        {
            "uid": 101,
            "email": "admin@admin.com",
            "role": "admin",
            "username": "admin",
            "addTime": 1499936103,
            "upTime": 1499936103
        }
    ]
}

/user/project GET #

描述: 根据路由id初始化项目数据

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

参数:

参数名 类型 描述 必选 支持版本
type String 可选group|interface|project
id Number

project#

/project/add POST #

描述: 添加项目分组

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

参数:

参数名 类型 描述 必选 支持版本
name String 项目名称，不能为空
basepath String 项目基本路径，不能为空
group_id Number 项目分组id，不能为空
group_name Number 项目分组名称，不能为空
project_type String private public
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:148

参数:

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

/project/del_member POST #

描述: 删除项目成员

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

参数:

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

/project/get_member_list GET #

描述: 获取项目成员列表

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

参数:

参数名 类型 描述 必选 支持版本
id Number 项目id，不能为空
示例：
{
    "errcode": 0,
    "errmsg": "success",
    "data": [
        {
            "_id": 101,
            "email": "admin@admin.com",
            "role": "admin",
            "add_time": 1499932673,
            "up_time": 1499932673
        }
    ]
}

/project/get GET #

描述: 获取项目信息

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

参数:

参数名 类型 描述 必选 支持版本
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:321

参数:

参数名 类型 描述 必选 支持版本
group_id Number 项目group_id，不能为空
示例：
{
    "errcode": 0,
    "errmsg": "success",
    "data": {
        "list": [
            {
                "_id": 529,
                "name": "yapi",
                "desc": "aaa",
                "prd_host": "http://www.yapi.com",
                "basepath": "/a/",
                "uid": 107,
                "group_id": 181,
                "add_time": 1500465369,
                "up_time": 1500522419,
                "__v": 0,
                "env": [],
                "members": [
                    "107"
                ]
            },
            {
                "_id": 558,
                "name": "12",
                "desc": "21\n",
                "prd_host": "http://11/",
                "basepath": "12/",
                "uid": 107,
                "group_id": 181,
                "add_time": 1500466250,
                "up_time": 1500466250,
                "__v": 0,
                "env": [],
                "members": [
                    "107"
                ]
            },
            {
                "_id": 626,
                "name": "1233",
                "desc": "123",
                "prd_host": "http://1234/",
                "basepath": "1234/",
                "uid": 107,
                "group_id": 181,
                "add_time": 1500471230,
                "up_time": 1500471230,
                "__v": 0,
                "env": [],
                "members": [
                    "107"
                ]
            },
            {
                "_id": 665,
                "name": "222",
                "desc": "222",
                "prd_host": "http://222/",
                "basepath": "222/",
                "uid": 107,
                "group_id": 181,
                "add_time": 1500471668,
                "up_time": 1500471668,
                "__v": 0,
                "env": [],
                "members": [
                    "107"
                ]
            },
            {
                "_id": 704,
                "name": "333",
                "desc": "222333",
                "prd_host": "http://333/",
                "basepath": "333/",
                "uid": 107,
                "group_id": 181,
                "add_time": 1500471674,
                "up_time": 1500471674,
                "__v": 0,
                "env": [],
                "members": [
                    "107"
                ]
            },
            {
                "_id": 743,
                "name": "444",
                "desc": "444",
                "prd_host": "https://444/",
                "basepath": "444/",
                "uid": 107,
                "group_id": 181,
                "add_time": 1500471695,
                "up_time": 1500471695,
                "__v": 0,
                "env": [],
                "members": [
                    "107"
                ]
            },
            {
                "_id": 763,
                "name": "122333",
                "desc": "3/",
                "prd_host": "http://33/",
                "basepath": "33/",
                "uid": 107,
                "group_id": 181,
                "add_time": 1500481743,
                "up_time": 1500481743,
                "__v": 0,
                "env": [],
                "members": [
                    "107"
                ]
            },
            {
                "_id": 778,
                "name": "555",
                "desc": "555",
                "prd_host": "https://555/",
                "basepath": "555/",
                "uid": 107,
                "group_id": 181,
                "add_time": 1500519203,
                "up_time": 1500519203,
                "__v": 0,
                "env": [],
                "members": [
                    "107"
                ]
            },
            {
                "_id": 823,
                "name": "5",
                "desc": "5",
                "prd_host": "http://5/",
                "basepath": "5/",
                "uid": 107,
                "group_id": 181,
                "add_time": 1500519769,
                "up_time": 1500519769,
                "__v": 0,
                "env": [],
                "members": [
                    "107"
                ]
            }
        ]
    }
}

/project/del POST #

描述: 删除项目

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

参数:

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

/project/change_member_role POST #

描述: 修改项目成员角色

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

参数:

参数名 类型 描述 必选 支持版本
id String 项目id
member_uid String 项目成员uid
role String 权限 ['owner'|'dev']

/project/upset POST #

描述: 项目设置

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

参数:

参数名 类型 描述 必选 支持版本
id Number 项目id，不能为空
icon String 项目icon
color Array 项目color
示例：
./api/project/upset

/project/up POST #

描述: 编辑项目

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

参数:

参数名 类型 描述 必选 支持版本
id Number 项目id，不能为空
name String 项目名称，不能为空
basepath String 项目基本路径，不能为空
desc String 项目描述
env Array 项目环境配置
env[].name String 环境名称
env[].domain String 环境域名
示例：

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

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

/project/search GET #

描述: 模糊搜索项目名称或者组名称

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

参数:

参数名 类型 描述 必选 支持版本
q String
示例：
{
    "errcode": 0,
    "errmsg": "ok",
    "data": {
        "project": [
            {
                "_id": 101,
                "name": "qav_project",
                "prdHost": "xxx.qunar.com:8080",
                "basepath": "/qav/",
                "addTime": 1500013365,
                "uid": 101,
                "upTime": 1500013365,
                "env": [],
                "members": [
                    "101"
                ]
            }
        ],
        "group": [
            {
                "_id": 193,
                "groupName": "qav",
                "groupDesc": "project qav",
                "uid": 0,
                "addTime": 1500013066,
                "upTime": 1500013066
            }
        ]
    }
}

/project/download GET #

描述: 下载项目的 Mock 数据

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

参数:

参数名 类型 描述 必选 支持版本
project_id String

interface#

/interface/add POST #

描述: 添加项目分组

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

参数:

参数名 类型 描述 必选 支持版本
project_id Number 项目id，不能为空
title String 接口标题，不能为空
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_body_type String 请求参数方式，有["form", "json", "text", "xml"]四种
req_params Array name, desc两个参数
req_body_form Mixed 请求参数,如果请求方式是form，参数是Array数组，其他格式请求参数是字符串
req_body_form[].name String 请求参数名
req_body_form[].value String 请求参数值，可填写生成规则（mock）。如@email，随机生成一条email
req_body_form[].type String 请求参数类型，有["text", "file"]两种
req_body_other String 非form类型的请求参数可保存到此字段
res_body_type String 相应信息的数据格式，有["json", "text", "xml"]三种
res_body String 响应信息，可填写任意字符串，如果res_body_type是json,则会调用mock功能
desc String 接口描述
示例：

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

{
   "title": "testapi",
   "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,
        "title": "testapi",
        "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:168

参数:

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

/interface/list GET #

描述: 接口列表

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

参数:

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

/interface/up POST #

描述: 编辑接口

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

参数:

参数名 类型 描述 必选 支持版本
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_body_type String 请求参数方式，有["form", "json", "text", "xml"]四种
req_body_form Mixed 请求参数,如果请求方式是form，参数是Array数组，其他格式请求参数是字符串
req_body_form[].name String 请求参数名
req_body_form[].value String 请求参数值，可填写生成规则（mock）。如@email，随机生成一条email
req_body_form[].type String 请求参数类型，有["text", "file"]两种
req_body_other String 非form类型的请求参数可保存到此字段
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:427

参数:

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

/interface/getCatMenu GET #

描述: 获取分类列表

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

参数:

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

follow#

/follow/list GET #

描述: 获取关注项目列表

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

参数:

参数名 类型 描述 必选 支持版本
page Number 分页页码
limit Number 分页大小
示例：
/follow/list

/follow/del POST #

描述: 取消关注

源码位置: ./server/controllers/follow.js:46

参数:

参数名 类型 描述 必选 支持版本
projectid Number
示例：
/follow/del

/follow/add GET #

描述: 添加关注

源码位置: ./server/controllers/follow.js:78

参数:

参数名 类型 描述 必选 支持版本
projectid Number 项目id
projectname String 项目名
icon String 项目icon
示例：
/follow/add

col#

/col/list GET #

描述: 获取所有接口集

源码位置: ./server/controllers/interfaceCol.js:16

参数:

参数名 类型 描述 必选 支持版本
project_id String email名称，不能为空

/col/add_col POST #

描述: 增加接口集

源码位置: ./server/controllers/interfaceCol.js:41

参数:

参数名 类型 描述 必选 支持版本
project_id Number
name String
desc String

/col/case_list GET #

描述: 获取一个接口集下的所有的接口用例

源码位置: ./server/controllers/interfaceCol.js:98

参数:

参数名 类型 描述 必选 支持版本
col_id String 接口集id

/col/add_case POST #

描述: 增加一个接口用例

源码位置: ./server/controllers/interfaceCol.js:133

参数:

参数名 类型 描述 必选 支持版本
casename String
col_id Number
project_id Number
domain String
path String
method String
req_query Object
req_headers Object
req_body_type String
req_body_form Array
req_body_other String

/col/up_case POST #

描述: 更新一个接口用例

源码位置: ./server/controllers/interfaceCol.js:213

参数:

参数名 类型 描述 必选 支持版本
id number
casename String
domain String
path String
method String
req_query Object
req_headers Object
req_body_type String
req_body_form Array
req_body_other String

/col/case GET #

描述: 获取一个接口用例详情

源码位置: ./server/controllers/interfaceCol.js:282

参数:

参数名 类型 描述 必选 支持版本
caseid String

/col/up_col POST #

描述: 更新一个接口集name或描述

源码位置: ./server/controllers/interfaceCol.js:339

参数:

参数名 类型 描述 必选 支持版本
name String
desc String

/col/up_col_index POST #

描述: 更新多个接口case index

源码位置: ./server/controllers/interfaceCol.js:380

参数:

参数名 类型 描述 必选 支持版本
id, index Array

/col/del_col GET #

描述: 删除一个接口集

源码位置: ./server/controllers/interfaceCol.js:422

参数:

参数名 类型 描述 必选 支持版本
String

log#

/log/list GET #

描述: 获取动态列表

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

参数:

参数名 类型 描述 必选 支持版本
typeid Number 动态类型id， 不能为空
page Number 分页页码
limit Number 分页大小
示例：
/log/list