开放接口api

yapi开放 api

开放接口api

获取项目基本信息

基本信息

Path： /api/project/get

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
token	是		项目token

新增接口分类

基本信息

Path： /api/interface/add_cat

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须
desc	text	否
name	text	是
project_id	text	是
token	text	是

获取菜单列表

基本信息

Path： /api/interface/getCatMenu

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
project_id	是
token	是

服务端数据导入

基本信息

Path： /api/open/import_data

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
type	text	是	swagger	导入方式
json	text	否	{"a": 1}	json 数据，类型为序列化后的字符串，请勿传递 object
merge	text	是	normal	数据同步方式 normal"(普通模式) , "good"(智能合并), "merge"(完全覆盖) 三种模式
token	text	是
url	text	否		导入数据url，如果存在该参数，将会通过 url 方式获取数据

获取接口数据（有详细接口数据定义文档）

基本信息

Path： /api/interface/get

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	示例	备注
id	是		接口id
token	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
errcode	number	非必须
errmsg	string	非必须
data	object	非必须
├─ _id	number	非必须		接口id
├─ project_id	number	非必须		项目id
├─ catid	number	非必须		品类id
├─ title	string	非必须
├─ path	string	非必须		请求路径
├─ method	string	非必须		请求method
├─ req_body_type	string	非必须		请求数据类型	枚举: raw,form,json
├─ res_body	string	非必须		返回数据
├─ res_body_type	string	非必须		返回数据类型	枚举: json,raw
├─ uid	number	非必须		用户uid
├─ add_time	number	非必须
├─ up_time	number	非必须
├─ req_body_form	object []	非必须		请求 form 参数	item 类型: object
├─ name	string	必须
├─ type	string	必须
├─ example	string	必须
├─ desc	string	必须
├─ required	string	必须	1		枚举: 1,0
├─ req_params	object []	非必须			item 类型: object
├─ name	string	必须
├─ example	string	必须
├─ desc	string	必须
├─ req_headers	object []	非必须			item 类型: object
├─ name	string	必须
├─ type	string	必须
├─ example	string	必须
├─ desc	string	必须
├─ required	string	必须	1		枚举: 1,0
├─ req_query	object []	非必须			item 类型: object
├─ name	string	必须
├─ type	string	必须
├─ example	string	必须
├─ desc	string	必须
├─ required	string	必须	1		枚举: 1,0
├─ status	string	非必须		接口状态
├─ edit_uid	number	非必须		修改的用户uid
├─ res_body_is_json_schema	boolean	必须	false	返回数据是否为 json-schema

获取某个分类下接口列表

基本信息

Path： /api/interface/list_cat

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
token	是		项目token
catid	是		分类id
page	否	1	当前页面
limit	否	10	每页数量，默认为10，如果不想要分页数据，可将 limit 设置为比较大的数字，比如 1000

新增接口

基本信息

Path： /api/interface/add

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

{
   "token": "xxx",
   "req_query": [],
   "req_headers": [
      {
         "name": "Content-Type"
      }
   ],
   "req_body_form": [],
   "title": "/api/group/list",
   "catid": "1376",
   "path": "/api/group/list",
   "status": "undone",
   "res_body_type": "json",
   "res_body": "{\n   \"errcode\": 0,\n   \"errmsg\": \"成功！\",\n   \"data\": [\n      {\n         \"_id\": 11,\n         \"group_name\": \"个人空间\",\n         \"add_time\": 1507877807,\n         \"up_time\": 1507877807,\n         \"type\": \"private\",\n         \"role\": \"owner\"\n      },\n      {\n         \"_id\": 358,\n         \"group_name\": \"测试新组长\",\n         \"group_desc\": \"是组长，但不是超级管理员的情况\",\n         \"uid\": 11,\n         \"add_time\": 1510152313,\n         \"up_time\": 1510216549,\n         \"type\": \"public\",\n         \"role\": \"admin\"\n      },\n      {\n         \"_id\": 295,\n         \"group_name\": \"eerurueuff\",\n         \"group_desc\": \"sdsuddhdh\",\n         \"uid\": 11,\n         \"add_time\": 1509678660,\n         \"up_time\": 1509678660,\n         \"type\": \"public\",\n         \"role\": \"admin\"\n      },\n      {\n         \"_id\": 19,\n         \"group_name\": \"demo\",\n         \"group_desc\": \"demo\",\n         \"uid\": 11,\n         \"add_time\": 1507877873,\n         \"up_time\": 1509679366,\n         \"type\": \"public\",\n         \"role\": \"admin\"\n      },\n      {\n         \"_id\": 402,\n         \"group_name\": \"yy\",\n         \"group_desc\": \"\",\n         \"uid\": 11,\n         \"add_time\": 1511431183,\n         \"up_time\": 1511431183,\n         \"type\": \"public\",\n         \"role\": \"admin\"\n      },\n      {\n         \"_id\": 390,\n         \"group_name\": \"ttt\",\n         \"group_desc\": \"4\",\n         \"uid\": 11,\n         \"add_time\": 1511430683,\n         \"up_time\": 1511430683,\n         \"type\": \"public\",\n         \"role\": \"admin\"\n      },\n      {\n         \"_id\": 384,\n         \"group_name\": \"yapi 上线测试分组（误删）\",\n         \"group_desc\": \"\",\n         \"uid\": 11,\n         \"add_time\": 1511264706,\n         \"up_time\": 1511264706,\n         \"type\": \"public\",\n         \"role\": \"admin\"\n      },\n      {\n         \"_id\": 373,\n         \"group_name\": \"test\",\n         \"group_desc\": \"巍峨如如如如\",\n         \"uid\": 11,\n         \"add_time\": 1510747315,\n         \"up_time\": 1510747315,\n         \"type\": \"public\",\n         \"role\": \"admin\"\n      },\n      {\n         \"_id\": 366,\n         \"group_name\": \"测试新组长1\",\n         \"group_desc\": \"是组长，但不是超级管理员的情况\",\n         \"uid\": 11,\n         \"add_time\": 1510152399,\n         \"up_time\": 1510152403,\n         \"type\": \"public\",\n         \"role\": \"admin\"\n      },\n      {\n         \"_id\": 151,\n         \"group_name\": \"test_123\",\n         \"group_desc\": \"\",\n         \"uid\": 11,\n         \"add_time\": 1508489714,\n         \"up_time\": 1508489714,\n         \"type\": \"public\",\n         \"role\": \"admin\"\n      },\n      {\n         \"_id\": 40,\n         \"group_name\": \"test1\",\n         \"group_desc\": \"\",\n         \"uid\": 11,\n         \"add_time\": 1507882145,\n         \"up_time\": 1507882145,\n         \"type\": \"public\",\n         \"role\": \"admin\"\n      }\n   ]\n}",
   "switch_notice": false,
   "message": "",
   "desc": "<p><br></p>",
   "method": "GET",
   "req_params": []
}

返回数据

{
   "errcode": 0,
   "errmsg": "成功！",
   "data": {
      "ok": 1,
      "nModified": 1,
      "n": 1
   }
}

新增或者更新接口

基本信息

Path： /api/interface/save

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

{
   "token": "...",
   "req_query": [],
   "req_headers": [
      {
         "name": "Content-Type"
      }
   ],
   "req_body_form": [],
   "title": "/api/group/list",
   "catid": "1376",
   "path": "/api/group/list",
   "status": "undone",
   "res_body_type": "json",
   "res_body": "{\n   \"errcode\": 0,\n   \"errmsg\": \"成功！\",\n   \"data\": [\n      {\n         \"_id\": 11,\n         \"group_name\": \"个人空间\",\n         \"add_time\": 1507877807,\n         \"up_time\": 1507877807,\n         \"type\": \"private\",\n         \"role\": \"owner\"\n      },\n      {\n         \"_id\": 358,\n         \"group_name\": \"测试新组长\",\n         \"group_desc\": \"是组长，但不是超级管理员的情况\",\n         \"uid\": 11,\n         \"add_time\": 1510152313,\n         \"up_time\": 1510216549,\n         \"type\": \"public\",\n         \"role\": \"admin\"\n      },\n      {\n         \"_id\": 295,\n         \"group_name\": \"eerurueuff\",\n         \"group_desc\": \"sdsuddhdh\",\n         \"uid\": 11,\n         \"add_time\": 1509678660,\n         \"up_time\": 1509678660,\n         \"type\": \"public\",\n         \"role\": \"admin\"\n      },\n      {\n         \"_id\": 19,\n         \"group_name\": \"demo\",\n         \"group_desc\": \"demo\",\n         \"uid\": 11,\n         \"add_time\": 1507877873,\n         \"up_time\": 1509679366,\n         \"type\": \"public\",\n         \"role\": \"admin\"\n      },\n      {\n         \"_id\": 402,\n         \"group_name\": \"yy\",\n         \"group_desc\": \"\",\n         \"uid\": 11,\n         \"add_time\": 1511431183,\n         \"up_time\": 1511431183,\n         \"type\": \"public\",\n         \"role\": \"admin\"\n      },\n      {\n         \"_id\": 390,\n         \"group_name\": \"ttt\",\n         \"group_desc\": \"4\",\n         \"uid\": 11,\n         \"add_time\": 1511430683,\n         \"up_time\": 1511430683,\n         \"type\": \"public\",\n         \"role\": \"admin\"\n      },\n      {\n         \"_id\": 384,\n         \"group_name\": \"yapi 上线测试分组（误删）\",\n         \"group_desc\": \"\",\n         \"uid\": 11,\n         \"add_time\": 1511264706,\n         \"up_time\": 1511264706,\n         \"type\": \"public\",\n         \"role\": \"admin\"\n      },\n      {\n         \"_id\": 373,\n         \"group_name\": \"test\",\n         \"group_desc\": \"巍峨如如如如\",\n         \"uid\": 11,\n         \"add_time\": 1510747315,\n         \"up_time\": 1510747315,\n         \"type\": \"public\",\n         \"role\": \"admin\"\n      },\n      {\n         \"_id\": 366,\n         \"group_name\": \"测试新组长1\",\n         \"group_desc\": \"是组长，但不是超级管理员的情况\",\n         \"uid\": 11,\n         \"add_time\": 1510152399,\n         \"up_time\": 1510152403,\n         \"type\": \"public\",\n         \"role\": \"admin\"\n      },\n      {\n         \"_id\": 151,\n         \"group_name\": \"test_123\",\n         \"group_desc\": \"\",\n         \"uid\": 11,\n         \"add_time\": 1508489714,\n         \"up_time\": 1508489714,\n         \"type\": \"public\",\n         \"role\": \"admin\"\n      },\n      {\n         \"_id\": 40,\n         \"group_name\": \"test1\",\n         \"group_desc\": \"\",\n         \"uid\": 11,\n         \"add_time\": 1507882145,\n         \"up_time\": 1507882145,\n         \"type\": \"public\",\n         \"role\": \"admin\"\n      }\n   ]\n}",
   "switch_notice": false,
   "message": "",
   "desc": "<p><br></p>",
   "method": "GET",
   "req_params": [],
   "id": "4396"
}

返回数据

{
   "errcode": 0,
   "errmsg": "成功！",
   "data": {
      "ok": 1,
      "nModified": 1,
      "n": 1
   }
}

获取接口列表数据

基本信息

Path： /api/interface/list

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	示例	备注
project_id	是
token	是
page	是	1	当前页数
limit	是	10	每页数量，默认为10，如果不想要分页数据，可将 limit 设置为比较大的数字，比如 1000

返回数据

{
   "errcode": 0,
   "errmsg": "成功！",
   "data": [
      {
         "_id": 4444,
         "project_id": 299,
         "catid": 1376,
         "title": "/api/group/del",
         "path": "/api/group/del",
         "method": "POST",
         "uid": 11,
         "add_time": 1511431246,
         "up_time": 1511751531,
         "status": "undone",
         "edit_uid": 0
      },
      {
         "_id": 4436,
         "project_id": 299,
         "catid": 1376,
         "title": "/api/group/up",
         "path": "/api/group/up",
         "method": "POST",
         "uid": 11,
         "add_time": 1511431246,
         "up_time": 1511751572,
         "status": "undone",
         "edit_uid": 0
      },
      {
         "_id": 4428,
         "project_id": 299,
         "catid": 1376,
         "title": "/api/group/get_member_list",
         "path": "/api/group/get_member_list",
         "method": "GET",
         "uid": 11,
         "add_time": 1511431245,
         "up_time": 1511431245,
         "status": "undone",
         "edit_uid": 0
      },
      {
         "_id": 4420,
         "project_id": 299,
         "catid": 1376,
         "title": "/api/log/list",
         "path": "/api/log/list",
         "method": "GET",
         "uid": 11,
         "add_time": 1511431245,
         "up_time": 1511431245,
         "status": "undone",
         "edit_uid": 0
      },
      {
         "_id": 4412,
         "project_id": 299,
         "catid": 1376,
         "title": "/api/group/get",
         "path": "/api/group/get",
         "method": "GET",
         "uid": 11,
         "add_time": 1511431245,
         "up_time": 1511431245,
         "status": "undone",
         "edit_uid": 0
      },
      {
         "_id": 4404,
         "project_id": 299,
         "catid": 1376,
         "title": "/api/project/list",
         "path": "/api/project/list",
         "method": "GET",
         "uid": 11,
         "add_time": 1511431245,
         "up_time": 1511431245,
         "status": "undone",
         "edit_uid": 0
      },
      {
         "_id": 4396,
         "project_id": 299,
         "catid": 1376,
         "title": "/api/group/list",
         "path": "/api/group/list",
         "method": "GET",
         "uid": 11,
         "add_time": 1511431245,
         "up_time": 1511431245,
         "status": "undone",
         "edit_uid": 0
      },
      {
         "_id": 4388,
         "project_id": 299,
         "catid": 1376,
         "title": "/api/group/add",
         "path": "/api/group/add",
         "method": "POST",
         "uid": 11,
         "add_time": 1511431245,
         "up_time": 1511493611,
         "status": "undone",
         "edit_uid": 0
      }
   ]
}

更新接口

基本信息

Path： /api/interface/up

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

{
   "token": "xxx",
   "req_query": [],
   "req_headers": [
      {
         "name": "Content-Type"
      }
   ],
   "req_body_form": [],
   "title": "/api/group/list",
   "catid": "1376",
   "path": "/api/group/list",
   "status": "undone",
   "res_body_type": "json",
   "res_body": "{\n   \"errcode\": 0,\n   \"errmsg\": \"成功！\",\n   \"data\": [\n      {\n         \"_id\": 11,\n         \"group_name\": \"个人空间\",\n         \"add_time\": 1507877807,\n         \"up_time\": 1507877807,\n         \"type\": \"private\",\n         \"role\": \"owner\"\n      },\n      {\n         \"_id\": 358,\n         \"group_name\": \"测试新组长\",\n         \"group_desc\": \"是组长，但不是超级管理员的情况\",\n         \"uid\": 11,\n         \"add_time\": 1510152313,\n         \"up_time\": 1510216549,\n         \"type\": \"public\",\n         \"role\": \"admin\"\n      },\n      {\n         \"_id\": 295,\n         \"group_name\": \"eerurueuff\",\n         \"group_desc\": \"sdsuddhdh\",\n         \"uid\": 11,\n         \"add_time\": 1509678660,\n         \"up_time\": 1509678660,\n         \"type\": \"public\",\n         \"role\": \"admin\"\n      },\n      {\n         \"_id\": 19,\n         \"group_name\": \"demo\",\n         \"group_desc\": \"demo\",\n         \"uid\": 11,\n         \"add_time\": 1507877873,\n         \"up_time\": 1509679366,\n         \"type\": \"public\",\n         \"role\": \"admin\"\n      },\n      {\n         \"_id\": 402,\n         \"group_name\": \"yy\",\n         \"group_desc\": \"\",\n         \"uid\": 11,\n         \"add_time\": 1511431183,\n         \"up_time\": 1511431183,\n         \"type\": \"public\",\n         \"role\": \"admin\"\n      },\n      {\n         \"_id\": 390,\n         \"group_name\": \"ttt\",\n         \"group_desc\": \"4\",\n         \"uid\": 11,\n         \"add_time\": 1511430683,\n         \"up_time\": 1511430683,\n         \"type\": \"public\",\n         \"role\": \"admin\"\n      },\n      {\n         \"_id\": 384,\n         \"group_name\": \"yapi 上线测试分组（误删）\",\n         \"group_desc\": \"\",\n         \"uid\": 11,\n         \"add_time\": 1511264706,\n         \"up_time\": 1511264706,\n         \"type\": \"public\",\n         \"role\": \"admin\"\n      },\n      {\n         \"_id\": 373,\n         \"group_name\": \"test\",\n         \"group_desc\": \"巍峨如如如如\",\n         \"uid\": 11,\n         \"add_time\": 1510747315,\n         \"up_time\": 1510747315,\n         \"type\": \"public\",\n         \"role\": \"admin\"\n      },\n      {\n         \"_id\": 366,\n         \"group_name\": \"测试新组长1\",\n         \"group_desc\": \"是组长，但不是超级管理员的情况\",\n         \"uid\": 11,\n         \"add_time\": 1510152399,\n         \"up_time\": 1510152403,\n         \"type\": \"public\",\n         \"role\": \"admin\"\n      },\n      {\n         \"_id\": 151,\n         \"group_name\": \"test_123\",\n         \"group_desc\": \"\",\n         \"uid\": 11,\n         \"add_time\": 1508489714,\n         \"up_time\": 1508489714,\n         \"type\": \"public\",\n         \"role\": \"admin\"\n      },\n      {\n         \"_id\": 40,\n         \"group_name\": \"test1\",\n         \"group_desc\": \"\",\n         \"uid\": 11,\n         \"add_time\": 1507882145,\n         \"up_time\": 1507882145,\n         \"type\": \"public\",\n         \"role\": \"admin\"\n      }\n   ]\n}",
   "switch_notice": false,
   "message": "",
   "desc": "<p><br></p>",
   "method": "GET",
   "req_params": [],
   "id": "4396"
}

返回数据

{
   "errcode": 0,
   "errmsg": "成功！",
   "data": {
      "ok": 1,
      "nModified": 1,
      "n": 1
   }
}

获取接口菜单列表

基本信息

Path： /api/interface/list_menu

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	示例	备注
project_id	是
token	是

返回数据

{
   "errcode": 0,
   "errmsg": "成功！",
   "data": [
      {
         "_id": 1376,
         "name": "公共分类",
         "project_id": 299,
         "desc": "公共分类",
         "uid": 11,
         "add_time": 1511428816,
         "up_time": 1511428816,
         "__v": 0,
         "list": [
            {
               "_id": 4396,
               "project_id": 299,
               "catid": 1376,
               "title": "/api/group/list",
               "path": "/api/group/list",
               "method": "GET",
               "req_body_type": "json",
               "res_body": "{\n   \"errcode\": 0,\n   \"errmsg\": \"成功！\",\n   \"data\": [\n      {\n         \"_id\": 11,\n         \"group_name\": \"个人空间\",\n         \"add_time\": 1507877807,\n         \"up_time\": 1507877807,\n         \"type\": \"private\",\n         \"role\": \"owner\"\n      },\n      {\n         \"_id\": 358,\n         \"group_name\": \"测试新组长\",\n         \"group_desc\": \"是组长，但不是超级管理员的情况\",\n         \"uid\": 11,\n         \"add_time\": 1510152313,\n         \"up_time\": 1510216549,\n         \"type\": \"public\",\n         \"role\": \"admin\"\n      },\n      {\n         \"_id\": 295,\n         \"group_name\": \"eerurueuff\",\n         \"group_desc\": \"sdsuddhdh\",\n         \"uid\": 11,\n         \"add_time\": 1509678660,\n         \"up_time\": 1509678660,\n         \"type\": \"public\",\n         \"role\": \"admin\"\n      },\n      {\n         \"_id\": 19,\n         \"group_name\": \"demo\",\n         \"group_desc\": \"demo\",\n         \"uid\": 11,\n         \"add_time\": 1507877873,\n         \"up_time\": 1509679366,\n         \"type\": \"public\",\n         \"role\": \"admin\"\n      },\n      {\n         \"_id\": 402,\n         \"group_name\": \"yy\",\n         \"group_desc\": \"\",\n         \"uid\": 11,\n         \"add_time\": 1511431183,\n         \"up_time\": 1511431183,\n         \"type\": \"public\",\n         \"role\": \"admin\"\n      },\n      {\n         \"_id\": 390,\n         \"group_name\": \"ttt\",\n         \"group_desc\": \"4\",\n         \"uid\": 11,\n         \"add_time\": 1511430683,\n         \"up_time\": 1511430683,\n         \"type\": \"public\",\n         \"role\": \"admin\"\n      },\n      {\n         \"_id\": 384,\n         \"group_name\": \"yapi 上线测试分组（误删）\",\n         \"group_desc\": \"\",\n         \"uid\": 11,\n         \"add_time\": 1511264706,\n         \"up_time\": 1511264706,\n         \"type\": \"public\",\n         \"role\": \"admin\"\n      },\n      {\n         \"_id\": 373,\n         \"group_name\": \"test\",\n         \"group_desc\": \"巍峨如如如如\",\n         \"uid\": 11,\n         \"add_time\": 1510747315,\n         \"up_time\": 1510747315,\n         \"type\": \"public\",\n         \"role\": \"admin\"\n      },\n      {\n         \"_id\": 366,\n         \"group_name\": \"测试新组长1\",\n         \"group_desc\": \"是组长，但不是超级管理员的情况\",\n         \"uid\": 11,\n         \"add_time\": 1510152399,\n         \"up_time\": 1510152403,\n         \"type\": \"public\",\n         \"role\": \"admin\"\n      },\n      {\n         \"_id\": 151,\n         \"group_name\": \"test_123\",\n         \"group_desc\": \"\",\n         \"uid\": 11,\n         \"add_time\": 1508489714,\n         \"up_time\": 1508489714,\n         \"type\": \"public\",\n         \"role\": \"admin\"\n      },\n      {\n         \"_id\": 40,\n         \"group_name\": \"test1\",\n         \"group_desc\": \"\",\n         \"uid\": 11,\n         \"add_time\": 1507882145,\n         \"up_time\": 1507882145,\n         \"type\": \"public\",\n         \"role\": \"admin\"\n      }\n   ]\n}",
               "res_body_type": "json",
               "uid": 11,
               "add_time": 1511431245,
               "up_time": 1511431245,
               "__v": 0,
               "req_body_form": [],
               "req_params": [],
               "req_headers": [
                  {
                     "name": "Content-Type",
                     "_id": "5a169c4d13e840ea363bb04a",
                     "required": "1"
                  }
               ],
               "req_query": [],
               "query_path": {
                  "path": "/api/group/list",
                  "params": []
               },
               "type": "static",
               "status": "undone",
               "edit_uid": 0
            },
            {
               "_id": 4404,
               "project_id": 299,
               "catid": 1376,
               "title": "/api/project/list",
               "path": "/api/project/list",
               "method": "GET",
               "req_body_type": "json",
               "res_body": "{\n   \"errcode\": 0,\n   \"errmsg\": \"成功！\",\n   \"data\": {\n      \"list\": []\n   }\n}",
               "res_body_type": "json",
               "uid": 11,
               "add_time": 1511431245,
               "up_time": 1511431245,
               "__v": 0,
               "req_body_form": [],
               "req_params": [],
               "req_headers": [
                  {
                     "name": "Content-Type",
                     "_id": "5a169c4d13e840ea363bb04e",
                     "required": "1"
                  }
               ],
               "req_query": [
                  {
                     "name": "group_id",
                     "_id": "5a169c4d13e840ea363bb04d",
                     "required": "1"
                  },
                  {
                     "name": "page",
                     "_id": "5a169c4d13e840ea363bb04c",
                     "required": "1"
                  },
                  {
                     "name": "limit",
                     "_id": "5a169c4d13e840ea363bb04b",
                     "required": "1"
                  }
               ],
               "query_path": {
                  "path": "/api/project/list",
                  "params": []
               },
               "type": "static",
               "status": "undone",
               "edit_uid": 0
            },
            {
               "_id": 4412,
               "project_id": 299,
               "catid": 1376,
               "title": "/api/group/get",
               "path": "/api/group/get",
               "method": "GET",
               "req_body_type": "json",
               "res_body": "{\n   \"errcode\": 0,\n   \"errmsg\": \"成功！\",\n   \"data\": {\n      \"_id\": 402,\n      \"group_name\": \"yy\",\n      \"group_desc\": \"\",\n      \"uid\": 11,\n      \"add_time\": 1511431183,\n      \"up_time\": 1511431183,\n      \"type\": \"public\",\n      \"role\": \"admin\"\n   }\n}",
               "res_body_type": "json",
               "uid": 11,
               "add_time": 1511431245,
               "up_time": 1511431245,
               "__v": 0,
               "req_body_form": [],
               "req_params": [],
               "req_headers": [
                  {
                     "name": "Content-Type",
                     "_id": "5a169c4d13e840ea363bb050",
                     "required": "1"
                  }
               ],
               "req_query": [
                  {
                     "name": "id",
                     "_id": "5a169c4d13e840ea363bb04f",
                     "required": "1"
                  }
               ],
               "query_path": {
                  "path": "/api/group/get",
                  "params": []
               },
               "type": "static",
               "status": "undone",
               "edit_uid": 0
            },
            {
               "_id": 4420,
               "project_id": 299,
               "catid": 1376,
               "title": "/api/log/list",
               "path": "/api/log/list",
               "method": "GET",
               "req_body_type": "json",
               "res_body": "{\n   \"errcode\": 0,\n   \"errmsg\": \"成功！\",\n   \"data\": {\n      \"list\": [\n         {\n            \"_id\": 18246,\n            \"content\": \"<a href=\\\"/user/profile/11\\\">admin</a> 新增了分组 <a href=\\\"/group/402\\\">yy</a>\",\n            \"type\": \"group\",\n            \"uid\": 11,\n            \"username\": \"admin\",\n            \"typeid\": 402,\n            \"add_time\": 1511431183,\n            \"__v\": 0\n         }\n      ],\n      \"total\": 1\n   }\n}",
               "res_body_type": "json",
               "uid": 11,
               "add_time": 1511431245,
               "up_time": 1511431245,
               "__v": 0,
               "req_body_form": [],
               "req_params": [],
               "req_headers": [
                  {
                     "name": "Content-Type",
                     "_id": "5a169c4d13e840ea363bb055",
                     "required": "1"
                  }
               ],
               "req_query": [
                  {
                     "name": "typeid",
                     "_id": "5a169c4d13e840ea363bb054",
                     "required": "1"
                  },
                  {
                     "name": "type",
                     "_id": "5a169c4d13e840ea363bb053",
                     "required": "1"
                  },
                  {
                     "name": "page",
                     "_id": "5a169c4d13e840ea363bb052",
                     "required": "1"
                  },
                  {
                     "name": "limit",
                     "_id": "5a169c4d13e840ea363bb051",
                     "required": "1"
                  }
               ],
               "query_path": {
                  "path": "/api/log/list",
                  "params": []
               },
               "type": "static",
               "status": "undone",
               "edit_uid": 0
            },
            {
               "_id": 4428,
               "project_id": 299,
               "catid": 1376,
               "title": "/api/group/get_member_list",
               "path": "/api/group/get_member_list",
               "method": "GET",
               "req_body_type": "json",
               "res_body": "{\n   \"errcode\": 0,\n   \"errmsg\": \"成功！\",\n   \"data\": []\n}",
               "res_body_type": "json",
               "uid": 11,
               "add_time": 1511431245,
               "up_time": 1511431245,
               "__v": 0,
               "req_body_form": [],
               "req_params": [],
               "req_headers": [
                  {
                     "name": "Content-Type",
                     "_id": "5a169c4d13e840ea363bb057",
                     "required": "1"
                  }
               ],
               "req_query": [
                  {
                     "name": "id",
                     "_id": "5a169c4d13e840ea363bb056",
                     "required": "1"
                  }
               ],
               "query_path": {
                  "path": "/api/group/get_member_list",
                  "params": []
               },
               "type": "static",
               "status": "undone",
               "edit_uid": 0
            },
            {
               "_id": 4436,
               "project_id": 299,
               "catid": 1376,
               "title": "/api/group/up",
               "path": "/api/group/up",
               "method": "POST",
               "req_body_type": "form",
               "res_body": "{\n   \"errcode\": 0,\n   \"errmsg\": \"成功！\",\n   \"data\": {\n      \"ok\": 1,\n      \"nModified\": 1,\n      \"n\": 1\n   }\n}",
               "res_body_type": "json",
               "uid": 11,
               "add_time": 1511431246,
               "up_time": 1511751572,
               "req_body_other": "{\n   \"group_name\": \"yy\",\n   \"group_desc\": \"hhh\",\n   \"id\": 402\n}",
               "__v": 0,
               "desc": "<p><br></p>",
               "req_body_form": [
                  {
                     "_id": "5a1b7f940b6d003897955456",
                     "type": "text",
                     "name": "group_name",
                     "required": "1"
                  },
                  {
                     "_id": "5a1b7f940b6d003897955455",
                     "desc": "",
                     "example": "",
                     "type": "text",
                     "name": "group_desc",
                     "required": "1"
                  },
                  {
                     "_id": "5a1b7f940b6d003897955454",
                     "desc": "",
                     "example": "",
                     "type": "text",
                     "name": "id",
                     "required": "1"
                  }
               ],
               "req_params": [],
               "req_headers": [
                  {
                     "_id": "5a1b7f940b6d003897955453",
                     "value": "application/x-www-form-urlencoded",
                     "name": "Content-Type",
                     "required": "1"
                  }
               ],
               "req_query": [],
               "query_path": {
                  "path": "/api/group/up",
                  "params": []
               },
               "type": "static",
               "status": "undone",
               "edit_uid": 0
            },
            {
               "_id": 4444,
               "project_id": 299,
               "catid": 1376,
               "title": "/api/group/del",
               "path": "/api/group/del",
               "method": "POST",
               "req_body_type": "form",
               "res_body": "{\n   \"errcode\": 0,\n   \"errmsg\": \"成功！\",\n   \"data\": {\n      \"ok\": 1,\n      \"n\": 1\n   }\n}",
               "res_body_type": "json",
               "uid": 11,
               "add_time": 1511431246,
               "up_time": 1511751531,
               "req_body_other": "{\n   \"id\": 402\n}",
               "__v": 0,
               "desc": "<p><br></p>",
               "req_body_form": [
                  {
                     "_id": "5a1b7f6b0b6d003897955452",
                     "type": "text",
                     "name": "id",
                     "required": "1"
                  }
               ],
               "req_params": [],
               "req_headers": [
                  {
                     "_id": "5a1b7f6b0b6d003897955451",
                     "value": "application/x-www-form-urlencoded",
                     "name": "Content-Type",
                     "required": "1"
                  }
               ],
               "req_query": [],
               "query_path": {
                  "path": "/api/group/del",
                  "params": []
               },
               "type": "static",
               "status": "undone",
               "edit_uid": 0
            },
            {
               "_id": 4388,
               "project_id": 299,
               "catid": 1376,
               "title": "/api/group/add",
               "path": "/api/group/add",
               "method": "POST",
               "req_body_type": "json",
               "res_body": "{\n   \"errcode\": 0,\n   \"errmsg\": \"成功！\",\n   \"data\": {\n      \"_id\": 402,\n      \"group_name\": \"yy\",\n      \"group_desc\": \"\",\n      \"uid\": 11,\n      \"members\": [],\n      \"type\": \"public\"\n   }\n}",
               "res_body_type": "json",
               "uid": 11,
               "add_time": 1511431245,
               "up_time": 1511493611,
               "req_body_other": "{\n   \"group_name\": \"yy\",\n   \"group_desc\": \"\",\n   \"owner_uids\": []\n}",
               "__v": 0,
               "desc": "<p><br></p>",
               "req_body_form": [],
               "req_params": [],
               "req_headers": [
                  {
                     "_id": "5a178feb7fd68d078196352b",
                     "value": "application/json",
                     "name": "Content-Type",
                     "required": "1"
                  }
               ],
               "req_query": [],
               "query_path": {
                  "path": "/api/group/add",
                  "params": []
               },
               "type": "static",
               "status": "undone",
               "edit_uid": 0
            }
         ]
      }
   ]
}

YAPI 接口文档

yapi开放 api

开放接口api

获取项目基本信息

基本信息

请求参数

新增接口分类

基本信息

请求参数

获取菜单列表

基本信息

请求参数

服务端数据导入

基本信息

请求参数

获取接口数据（有详细接口数据定义文档）

基本信息

请求参数

返回数据

获取某个分类下接口列表

基本信息

请求参数

新增接口

基本信息

请求参数

返回数据

新增或者更新接口

基本信息

请求参数

返回数据

获取接口列表数据

基本信息

请求参数

返回数据

更新接口

基本信息

请求参数

返回数据

获取接口菜单列表

基本信息

请求参数

返回数据