EasyDarwin/www/apidoc/api_data.json

2 lines
9.7 KiB
JSON
Raw Normal View History

[ { "type": "get", "url": "/api/v1/players", "title": "获取拉流列表", "group": "stats", "name": "Players", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "Number", "optional": true, "field": "start", "description": "<p>分页开始,从零开始</p>" }, { "group": "Parameter", "type": "Number", "optional": true, "field": "limit", "description": "<p>分页大小</p>" }, { "group": "Parameter", "type": "String", "optional": true, "field": "sort", "description": "<p>排序字段</p>" }, { "group": "Parameter", "type": "String", "allowedValues": [ "ascending", "descending" ], "optional": true, "field": "order", "description": "<p>排序顺序</p>" }, { "group": "Parameter", "type": "String", "optional": true, "field": "q", "description": "<p>查询参数</p>" } ] } }, "success": { "fields": { "200": [ { "group": "200", "type": "Number", "optional": false, "field": "total", "description": "<p>总数</p>" }, { "group": "200", "type": "Array", "optional": false, "field": "rows", "description": "<p>推流列表</p>" }, { "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": "<p>传输模式</p>" }, { "group": "200", "type": "Number", "optional": false, "field": "rows.inBytes", "description": "<p>入口流量</p>" }, { "group": "200", "type": "Number", "optional": false, "field": "rows.outBytes", "description": "<p>出口流量</p>" }, { "group": "200", "type": "String", "optional": false, "field": "rows.startAt", "description": "<p>开始时间</p>" } ] } }, "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": "<p>分页开始,从零开始</p>" }, { "group": "Parameter", "type": "Number", "optional": true, "field": "limit", "description": "<p>分页大小</p>" }, { "group": "Parameter", "type": "String", "optional": true, "field": "sort", "description": "<p>排序字段</p>" }, { "group": "Parameter", "type": "String", "allowedValues": [ "ascending", "descending" ], "optional": true, "field": "order", "description": "<p>