+ +
+ +

group#

+ +
+
+

+ /group/get + + GET + + + # +

+
+

+ 描述: + 添加项目分组 +

+ +

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

+ + +

+ 参数: +

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

+ /group/add + + POST + + + # +

+
+

+ 描述: + 添加项目分组 +

+ +

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

+ + +

+ 参数: +

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

+ /group/add_member + + POST + + + # +

+
+

+ 描述: + 添加项目分组成员 +

+ +

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

+ + +

+ 参数: +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
参数名类型描述必选支持版本
idString项目分组id + + + +
member_uidString项目分组成员uid + + + +
roleString成员角色，owner or dev + + + +
+
+ + + +
+ +
+
+

+ /group/change_member_role + + POST + + + # +

+
+

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

+ +

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

+ + +

+ 参数: +

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

+ /group/get_member_list + + GET + + + # +

+
+

+ 描述: + 获取所有项目成员 +

+ +

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

+ + +

+ 参数: +

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

+ /group/del_member + + POST + + + # +

+
+

+ 描述: + 删除项目成员 +

+ +

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

+ + +

+ 参数: +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
参数名类型描述必选支持版本
idString项目分组id + + + +
member_uidString项目分组成员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 +

+ + +

+ 参数: +

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

+ /group/up + + post + + + # +

+
+

+ 描述: + 更新项目分组 +

+ +

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

+ + +

+ 参数: +

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

user#

+ +
+
+

+ /user/login + + POST + + + # +

+
+

+ 描述: + 用户登录接口 +

+ +

+ 源码位置: + ./server/controllers/user.js:18 +

+ + +

+ 参数: +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
参数名类型描述必选支持版本
emailStringemail名称，不能为空 + + + +
passwordString密码，不能为空 + + + +
+
+ + +
示例：
+ 
{
+    "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:162 +

+ + +

+ 参数: +

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

+ /user/reg + + POST + + + # +

+
+

+ 描述: + 用户注册接口 +

+ +

+ 源码位置: + ./server/controllers/user.js:227 +

+ + +

+ 参数: +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
参数名类型描述必选支持版本
emailStringemail名称，不能为空 + + + +
passwordString密码，不能为空 + + + +
usernameString用户名 + +
+
+ + +
示例：
+ 
{
+    "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:301 +

+ + +

+ 参数: +

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

+ /user/find + + GET + + + # +

+
+

+ 描述: + 获取用户个人信息 +

+ +

+ 源码位置: + ./server/controllers/user.js:329 +

+ + +

+ 参数: +

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

+ /user/del + + POST + + + # +

+
+

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

+ +

+ 源码位置: + ./server/controllers/user.js:368 +

+ + +

+ 参数: +

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

+ /user/update + + POST + + + # +

+
+

+ 描述: + 更新用户个人信息 +

+ +

+ 源码位置: + ./server/controllers/user.js:399 +

+ + +

+ 参数: +

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

+ /user/upload_avatar + + POST + + + # +

+
+

+ 描述: + 上传用户头像 +

+ +

+ 源码位置: + ./server/controllers/user.js:454 +

+ + +

+ 参数: +

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

+ /user/avatar + + GET + + + # +

+
+

+ 描述: + 根据用户uid头像 +

+ +

+ 源码位置: + ./server/controllers/user.js:497 +

+ + +

+ 参数: +

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

+ /user/search + + GET + + + # +

+
+

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

+ +

+ 源码位置: + ./server/controllers/user.js:529 +

+ + +

+ 参数: +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
参数名类型描述必选支持版本
qString + + + +
+
+ + +
示例：
+ 
{
+    "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:574 +

+ + +

+ 参数: +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
参数名类型描述必选支持版本
typeString可选group|interface|project + + + +
idNumber + + + +
+
+ + + +
+ + +

project#

+ +
+
+

+ /project/add + + POST + + + # +

+
+

+ 描述: + 添加项目分组 +

+ +

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

+ + +

+ 参数: +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
参数名类型描述必选支持版本
nameString项目名称，不能为空 + + + +
basepathString项目基本路径，不能为空 + + + +
group_idNumber项目分组id，不能为空 + + + +
group_nameNumber项目分组名称，不能为空 + + + +
project_typeStringprivate public + + + +
descString项目描述 + +
+
+ + +
示例：
+ 
{
+    "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:149 +

+ + +

+ 参数: +

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

+ /project/del_member + + POST + + + # +

+
+

+ 描述: + 删除项目成员 +

+ +

+ 源码位置: + ./server/controllers/project.js:202 +

+ + +

+ 参数: +

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

+ /project/get_member_list + + GET + + + # +

+
+

+ 描述: + 获取项目成员列表 +

+ +

+ 源码位置: + ./server/controllers/project.js:265 +

+ + +

+ 参数: +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
参数名类型描述必选支持版本
idNumber项目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:290 +

+ + +

+ 参数: +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
参数名类型描述必选支持版本
idNumber项目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:322 +

+ + +

+ 参数: +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
参数名类型描述必选支持版本
group_idNumber项目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 +

+ + +

+ 参数: +

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

+ /project/change_member_role + + POST + + + # +

+
+

+ 描述: + 修改项目成员角色 +

+ +

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

+ + +

+ 参数: +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
参数名类型描述必选支持版本
idString项目id + + + +
member_uidString项目成员uid + + + +
roleString权限 ['owner'|'dev'] + + + +
+
+ + + +
+ +
+
+

+ /project/upset + + POST + + + # +

+
+

+ 描述: + 项目设置 +

+ +

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

+ + +

+ 参数: +

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

+ /project/up + + POST + + + # +

+
+

+ 描述: + 编辑项目 +

+ +

+ 源码位置: + ./server/controllers/project.js:500 +

+ + +

+ 参数: +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
参数名类型描述必选支持版本
idNumber项目id，不能为空 + + + +
nameString项目名称，不能为空 + + + +
basepathString项目基本路径，不能为空 + + + +
descString项目描述 + +
envArray项目环境配置 + +
env[].nameString环境名称 + +
env[].domainString环境域名 + +
+
+ + +
示例：
+ 

+//请求示例
+{
+    "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:581 +

+ + +

+ 参数: +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
参数名类型描述必选支持版本
qString + + + +
+
+ + +
示例：
+ 
{
+    "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:635 +

+ + +

+ 参数: +

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

interface#

+ +
+
+

+ /interface/add + + POST + + + # +

+
+

+ 描述: + 添加项目分组 +

+ +

+ 源码位置: + ./server/controllers/interface.js:15 +

+ + +

+ 参数: +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
参数名类型描述必选支持版本
project_idNumber项目id，不能为空 + + + +
titleString接口标题，不能为空 + + + +
pathString接口请求路径，不能为空 + + + +
methodString请求方式 + + + +
req_headersArray请求的header信息 + +
req_headers[].nameString请求的header信息名 + +
req_headers[].valueString请求的header信息值 + +
req_headers[].requiredBoolean是否是必须，默认为否 + +
req_headers[].descStringheader描述 + +
req_body_typeString请求参数方式，有["form", "json", "text", "xml"]四种 + +
req_paramsArrayname, desc两个参数 + +
req_body_formMixed请求参数,如果请求方式是form，参数是Array数组，其他格式请求参数是字符串 + +
req_body_form[].nameString请求参数名 + +
req_body_form[].valueString请求参数值，可填写生成规则（mock）。如@email，随机生成一条email + +
req_body_form[].typeString请求参数类型，有["text", "file"]两种 + +
req_body_otherString非form类型的请求参数可保存到此字段 + +
res_body_typeString相应信息的数据格式，有["json", "text", "xml"]三种 + +
res_bodyString响应信息，可填写任意字符串，如果res_body_type是json,则会调用mock功能 + +
descString接口描述 + +
+
+ + +
示例：
+ 

+//请求  /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:134 +

+ + +

+ 参数: +

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

+ /interface/list + + GET + + + # +

+
+

+ 描述: + 接口列表 +

+ +

+ 源码位置: + ./server/controllers/interface.js:159 +

+ + +

+ 参数: +

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

+ /interface/up + + POST + + + # +

+
+

+ 描述: + 编辑接口 +

+ +

+ 源码位置: + ./server/controllers/interface.js:221 +

+ + +

+ 参数: +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
参数名类型描述必选支持版本
idNumber接口id，不能为空 + + + +
pathString接口请求路径 + +
methodString请求方式 + +
req_headersArray请求的header信息 + +
req_headers[].nameString请求的header信息名 + +
req_headers[].valueString请求的header信息值 + +
req_headers[].requiredBoolean是否是必须，默认为否 + +
req_headers[].descStringheader描述 + +
req_body_typeString请求参数方式，有["form", "json", "text", "xml"]四种 + +
req_body_formMixed请求参数,如果请求方式是form，参数是Array数组，其他格式请求参数是字符串 + +
req_body_form[].nameString请求参数名 + +
req_body_form[].valueString请求参数值，可填写生成规则（mock）。如@email，随机生成一条email + +
req_body_form[].typeString请求参数类型，有["text", "file"]两种 + +
req_body_otherString非form类型的请求参数可保存到此字段 + +
res_body_typeString相应信息的数据格式，有["json", "text", "xml"]三种 + +
res_bodyString响应信息，可填写任意字符串，如果res_body_type是json,则会调用mock功能 + +
descString接口描述 + +
+
+ + +
示例：
+ 
{
+    "errcode": 0,
+    "errmsg": "success",
+    "data": {
+        "n": 1,
+        "nModified": 1,
+        "ok": 1
+    }
+}
+ + +
+ +
+
+

+ /interface/del + + GET + + + # +

+
+

+ 描述: + 删除接口 +

+ +

+ 源码位置: + ./server/controllers/interface.js:376 +

+ + +

+ 参数: +

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

follow#

+ +
+
+

+ /follow/list + + GET + + + # +

+
+

+ 描述: + 获取关注项目列表 +

+ +

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

+ + +

+ 参数: +

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

+ /follow/del + + POST + + + # +

+
+

+ 描述: + 取消关注 +

+ +

+ 源码位置: + ./server/controllers/follow.js:45 +

+ + +

+ 参数: +

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

+ /follow/add + + GET + + + # +

+
+

+ 描述: + 添加关注 +

+ +

+ 源码位置: + ./server/controllers/follow.js:77 +

+ + +

+ 参数: +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
参数名类型描述必选支持版本
projectidNumber项目id + + + +
projectnameString项目名 + + + +
iconString项目icon + + + +
+
+ + +
示例：
+ 
/follow/add
+ + +
+ + +

col#

+ +
+
+

+ /col/list + + GET + + + # +

+
+

+ 描述: + 获取所有接口集 +

+ +

+ 源码位置: + ./server/controllers/interfaceCol.js:12 +

+ + +

+ 参数: +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
参数名类型描述必选支持版本
project_idStringemail名称，不能为空 + + + +
+
+ + + +
+ +
+
+

+ /col/add_col + + POST + + + # +

+
+

+ 描述: + 增加接口集 +

+ +

+ 源码位置: + ./server/controllers/interfaceCol.js:37 +

+ + +

+ 参数: +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
参数名类型描述必选支持版本
project_idNumber + + + +
nameString + + + +
descString + + + +
+
+ + + +
+ +
+
+

+ /col/case_list + + GET + + + # +

+
+

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

+ +

+ 源码位置: + ./server/controllers/interfaceCol.js:94 +

+ + +

+ 参数: +

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

+ /col/add_case + + POST + + + # +

+
+

+ 描述: + 增加一个接口用例 +

+ +

+ 源码位置: + ./server/controllers/interfaceCol.js:116 +

+ + +

+ 参数: +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
参数名类型描述必选支持版本
casenameString + + + +
col_idNumber + + + +
project_idNumber + + + +
domainString + + + +
pathString + + + +
methodString + + + +
req_queryObject + + + +
req_headersObject + + + +
req_body_typeString + + + +
req_body_formArray + + + +
req_body_otherString + + + +
+
+ + + +
+ +
+
+

+ /col/up_case + + POST + + + # +

+
+

+ 描述: + 更新一个接口用例 +

+ +

+ 源码位置: + ./server/controllers/interfaceCol.js:192 +

+ + +

+ 参数: +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
参数名类型描述必选支持版本
idnumber + + + +
casenameString + + + +
domainString + + + +
pathString + + + +
methodString + + + +
req_queryObject + + + +
req_headersObject + + + +
req_body_typeString + + + +
req_body_formArray + + + +
req_body_otherString + + + +
+
+ + + +
+ +
+
+

+ /col/case + + GET + + + # +

+
+

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

+ +

+ 源码位置: + ./server/controllers/interfaceCol.js:259 +

+ + +

+ 参数: +

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

+ /col/up_col + + POST + + + # +

+
+

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

+ +

+ 源码位置: + ./server/controllers/interfaceCol.js:280 +

+ + +

+ 参数: +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
参数名类型描述必选支持版本
nameString + + + +
descString + + + +
+
+ + + +
+ +
+
+

+ /col/up_col_index + + POST + + + # +

+
+

+ 描述: + 更新多个接口case index +

+ +

+ 源码位置: + ./server/controllers/interfaceCol.js:321 +

+ + +

+ 参数: +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
参数名类型描述必选支持版本
id, indexArray + +
+
+ + + +
+ +
+
+

+ /col/del_col + + GET + + + # +

+
+

+ 描述: + 删除一个接口集 +

+ +

+ 源码位置: + ./server/controllers/interfaceCol.js:363 +

+ + +

+ 参数: +

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

log#

+ +
+
+

+ /log/list + + GET + + + # +

+
+

+ 描述: + 获取动态列表 +

+ +

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

+ + +

+ 参数: +

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