define({ "api": [ { "type": "get", "url": "/api/v1/players", "title": "获取拉流列表", "group": "stats", "name": "Players", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "Number", "optional": true, "field": "start", "description": "

分页开始,从零开始

" }, { "group": "Parameter", "type": "Number", "optional": true, "field": "limit", "description": "

分页大小

" }, { "group": "Parameter", "type": "String", "optional": true, "field": "sort", "description": "

排序字段

" }, { "group": "Parameter", "type": "String", "allowedValues": [ "ascending", "descending" ], "optional": true, "field": "order", "description": "

排序顺序

" }, { "group": "Parameter", "type": "String", "optional": true, "field": "q", "description": "

查询参数

" } ] } }, "success": { "fields": { "200": [ { "group": "200", "type": "Number", "optional": false, "field": "total", "description": "

总数

" }, { "group": "200", "type": "Array", "optional": false, "field": "rows", "description": "

推流列表

" }, { "group": "200", "type": "String", "optional": false, "field": "rows.id", "description": "" }, { "group": "200", "type": "String", "optional": false, "field": "rows.path", "description": "" }, { "group": "200", "type": "String", "optional": false, "field": "rows.transType", "description": "

传输模式

" }, { "group": "200", "type": "Number", "optional": false, "field": "rows.inBytes", "description": "

入口流量

" }, { "group": "200", "type": "Number", "optional": false, "field": "rows.outBytes", "description": "

出口流量

" }, { "group": "200", "type": "String", "optional": false, "field": "rows.startAt", "description": "

开始时间

" } ] } }, "version": "0.0.0", "filename": "routers/stats.go", "groupTitle": "查询接口" }, { "type": "get", "url": "/api/v1/pushers", "title": "获取推流列表", "group": "stats", "name": "Pushers", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "Number", "optional": true, "field": "start", "description": "

分页开始,从零开始

" }, { "group": "Parameter", "type": "Number", "optional": true, "field": "limit", "description": "

分页大小

" }, { "group": "Parameter", "type": "String", "optional": true, "field": "sort", "description": "

排序字段

" }, { "group": "Parameter", "type": "String", "allowedValues": [ "ascending", "descending" ], "optional": true, "field": "order", "description": "

排序顺序

" }, { "group": "Parameter", "type": "String", "optional": true, "field": "q", "description": "

查询参数

" } ] } }, "success": { "fields": { "200": [ { "group": "200", "type": "Number", "optional": false, "field": "total", "description": "

总数

" }, { "group": "200", "type": "Array", "optional": false, "field": "rows", "description": "

推流列表

" }, { "group": "200", "type": "String", "optional": false, "field": "rows.id", "description": "" }, { "group": "200", "type": "String", "optional": false, "field": "rows.path", "description": "" }, { "group": "200", "type": "String", "optional": false, "field": "rows.transType", "description": "

传输模式

" }, { "group": "200", "type": "Number", "optional": false, "field": "rows.inBytes", "description": "

入口流量

" }, { "group": "200", "type": "Number", "optional": false, "field": "rows.outBytes", "description": "

出口流量

" }, { "group": "200", "type": "String", "optional": false, "field": "rows.startAt", "description": "

开始时间

" }, { "group": "200", "type": "Number", "optional": false, "field": "rows.onlines", "description": "

在线人数

" } ] } }, "version": "0.0.0", "filename": "routers/stats.go", "groupTitle": "查询接口" }, { "type": "get", "url": "/getserverinfo", "title": "获取平台运行信息", "group": "sys", "name": "GetServerInfo", "success": { "fields": { "200": [ { "group": "200", "type": "String", "optional": false, "field": "Hardware", "description": "

硬件信息

" }, { "group": "200", "type": "String", "optional": false, "field": "RunningTime", "description": "

运行时间

" }, { "group": "200", "type": "String", "optional": false, "field": "StartUpTime", "description": "

启动时间

" }, { "group": "200", "type": "String", "optional": false, "field": "Server", "description": "

软件信息

" } ] } }, "version": "0.0.0", "filename": "routers/sys.go", "groupTitle": "API接口" }, { "type": "get", "url": "/login", "title": "登录", "group": "sys", "name": "Login", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "String", "optional": false, "field": "username", "description": "

用户名

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "password", "description": "

密码(经过md5加密,32位长度,不带中划线,不区分大小写)

" } ] } }, "success": { "examples": [ { "title": "成功", "content": "HTTP/1.1 200 OK\nSet-Cookie: token=s%3ArkyMbQE0M.5AKAOXbW8c7iP%2BOo0venPkCYiEiPK9FY31mB6AlFQak;//用着后续接口调用的 token", "type": "json" } ] }, "version": "0.0.0", "filename": "routers/sys.go", "groupTitle": "API接口" }, { "type": "get", "url": "/logout", "title": "登出", "group": "sys", "name": "Logout", "version": "0.0.0", "filename": "routers/sys.go", "groupTitle": "API接口", "success": { "examples": [ { "title": "成功", "content": "HTTP/1.1 200 OK", "type": "json" } ] } }, { "type": "get", "url": "/restart", "title": "重启服务", "group": "sys", "name": "Restart", "version": "0.0.0", "filename": "routers/sys.go", "groupTitle": "API接口", "success": { "examples": [ { "title": "成功", "content": "HTTP/1.1 200 OK", "type": "json" } ] } }, { "type": "get", "url": "/userInfo", "title": "获取当前登录用户信息", "group": "sys", "name": "UserInfo", "version": "0.0.0", "filename": "routers/sys.go", "groupTitle": "API接口", "success": { "fields": { "200": [ { "group": "200", "type": "String", "optional": false, "field": "id", "description": "" }, { "group": "200", "type": "String", "optional": false, "field": "name", "description": "

用户名

" }, { "group": "200", "type": "String[]", "optional": true, "field": "roles", "description": "

角色列表

" } ] } } } ] });