Yapi接口文档
1.分组
分组列表
URL
/api/group/list
HTTP请求方式
GET
请求参数
参数 必选 类型 说明
新增分组
URL
/api/group/add
HTTP请求方式
POST
请求参数
{
"group_name":"aaa", 必填
"group_desc":"aaa",
"owner_uids":["27"]
}
修改分组
URL
/api/group/up
HTTP请求方式
POST
请求参数
{
"group_name":"aaaa",
"group_desc":"aaa",
"custom_field1":{"enable":false},
"id":155
}
删除分组
URL
/api/project/del
HTTP请求方式
POST
请求参数
body:
{
"id": 233
}
分组动态
URL
/api/log/list
HTTP请求方式
GET
请求参数
参数 必选 类型 说明 typeid true String 分组ID type true String 类型 limit String page
http://172.28.96.254:3000/api/log/list?typeid=155&type=group&page=1&limit=10
2.项目
项目列表
URL
/api/project/list
HTTP请求方式
GET
请求参数
参数 必选 类型 说明 group_id true String 分组ID page String limit String
新增项目
URL
/api/project/add
HTTP请求方式
POST
请求参数
{
"name":"passdemo1",
"basepath":"/passdemo",
"desc":"pass",
"group_id":"131",
"icon":"code-o",
"color":"yellow",
"project_type":"private"
}
修改项目
URL
/api/project/up
HTTP请求方式
POST
请求参数
{
"name":"passdemo1",
"project_type":"private",
"basepath":"/passdemo",
"switch_notice":true,
"desc":"passss",
"id":235,
"env":[
{"header":[],
"global":[],
"_id":"5d849218026c803516da1393",
"name":"local",
"domain":"http://127.0.0.1"
}
],
"group_id":"131",
"strice":false,
"is_json5":false,
"tag":[]
}
删除项目
URL
/api/project/del
HTTP请求方式
POST
请求参数
3.成员
组成员列表
URL
/api/group/get_member_list
HTTP请求方式
GET
请求参数
参数 必选 类型 说明 id true String 分组ID
项目成员列表
URL
/api/project/get_member_list
HTTP请求方式
GET
请求参数
参数 必选 类型 说明 id true String 项目ID
组添加成员
URL
/api/group/add_member
HTTP请求方式
POST
{
"id":131, 组Id
"member_uids":["27"], 用户ID
"role":"dev" 角色
}
项目添加成员
URL
/api/project/add_member
HTTP请求方式
POST
{
"id":235, 项目Id
"member_uids":["67"], 用户ID
"role":"dev" 角色
}
组删除成员
URL
/api/group/del_member
HTTP请求方式
POST
{"id":131,"member_uid":27}
项目删除成员
URL
/api/project/del_member
HTTP请求方式
POST
{"id":"235","member_uid":27}
修改成员权限
URL
/api/group/change_member_role
HTTP请求方式
POST
{"id":131,"member_uid":"27","role":"guest"}
修改项目成员权限
URL
/api/project/change_member_role
HTTP请求方式
POST
{"id":"235","member_uid":"59","role":"dev"}
4.搜索
搜索分组/项目/
URL
/api/project/search?q=qqq
HTTP请求方式
GET
参数：q
用户搜索
URL
/api/user/search?q=1
HTTP请求方式
GET
参数：q
5.动态
动态
URL
/api/log/list
HTTP请求方式
GET
参数：?typeid=147 true 类型ID(分组ID,项目ID)
&type=group true 类型
&page=1& 分页
limit=10
selectValue 搜索API名称
6.设置
环境配置
URL
/api/project/up_env
HTTP请求方式
POST
{
"id":235,"env":
[
{
"_id":"5d849218026c803516da1393",
"name":"local",
"domain":"http://127.0.0.1",
"header":
[
{
"name":"Accept-Language",
"value":"aaa"
},
{
"name":"Cookie",
"value":"cookie=123"
}
],
"global":[
{
"name":"aa",
"value":"aa"
}
]
}
]
}
请求配置
URL
HTTP请求方式
GET
Tag配置
URL
/api/project/up_tag
HTTP请求方式
POST
{
"id":235,
"tag":[
{
"name":"aaa",
"desc":"aaa"
},
{
"name":"aaab",
"desc":"bbbb"
}
]
}
全局mock脚本
URL
HTTP请求方式
GET
6.接口
分类列表
URL
/api/interface/list_menu?project_id=239
HTTP请求方式
GET
project_id=239
添加分类
URL
/api/interface/add_cat
HTTP请求方式
POST
{"name":"aaa","desc":"aaa","project_id":"235"}
修改分类
URL
/api/interface/up_cat
HTTP请求方式
POST
{"catid":4925,"name":"csadd11","desc":"csadd11"}
删除分类
URL
/api/interface/del_cat
HTTP请求方式
POST
{"catid":4895}
接口列表
URL
/api/interface/list_cat?page=1&limit=20&catid=4913
HTTP请求方式
GET
page=1&limit=20&catid=4913
新增接口
URL
/api/interface/add
HTTP请求方式
POST
{"method":"GET","catid":"4901","title":"aaacs","path":"/ccc","project_id":"235"}
接口编辑
URL
/api/interface/up
HTTP请求方式
POST
{
"req_query":[
{
"name":"user",
"required":"1",
"example":"add",
"desc":"用户名"
}
],
"req_headers":[],
"req_body_form":[],
"title":"aaacs",
"catid":"4901",
"path":"/ccc",
"tag":["aaa"],
"status":"undone",
"req_body_is_json_schema":true,
"res_body_is_json_schema":true,
"res_body_type":"json",
"res_body":
"{\"type\":\"object\",\"title\":\"empty object\",\"properties\":{},\"description\":\"sss\"}",
"switch_notice":true,
"api_opened":false,
"desc":"<p>asdasd</p>\n",
"markdown":"asdasd",
"method":"GET",
"req_params":[],
"id":"8057"
}
删除接口
URL
/api/interface/del
HTTP请求方式
POST
{"id":8057}