github
/
EasyDarwin
mirror of https://github.com/EasyDarwin/EasyDarwin
1
0
Fork 0
Code Issues Releases Wiki Activity

update apidoc

pull/132/head
Alex 2018-12-03 13:53:41 +08:00
parent 69bc6b3677
commit baa42567c7
10 changed files with 62 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -3,6 +3,7 @@
/EasyDarwin.exe /EasyDarwin.exe
/EasyDarwin.exe~ /EasyDarwin.exe~
/logs /logs
/*.log
node_modules node_modules
*.db *.db
*.db.bak *.db.bak

4
routers/record.go
View File

@ -29,7 +29,7 @@ import (
*/ */
/** /**
* @api {get} /api/vi/record/folders 获取所有录像文件夹 * @api {get} /api/v1/record/folders 获取所有录像文件夹
* @apiGroup record * @apiGroup record
* @apiName RecordFolders * @apiName RecordFolders
* @apiParam {Number} [start] 分页开始,从零开始 * @apiParam {Number} [start] 分页开始,从零开始
@ -80,7 +80,7 @@ func (h *APIHandler) RecordFolders(c *gin.Context) {
} }
/** /**
* @api {get} /api/vi/record/files 获取所有录像文件 * @api {get} /api/v1/record/files 获取所有录像文件
* @apiGroup record * @apiGroup record
* @apiName RecordFiles * @apiName RecordFiles
* @apiParam {Number} folder 录像文件所在的文件夹 * @apiParam {Number} folder 录像文件所在的文件夹

4
routers/streams.go
View File

@ -16,7 +16,7 @@ import (
*/ */
/** /**
* @api {get} /api/vi/stream/start 启动拉流 * @api {get} /api/v1/stream/start 启动拉转推
* @apiGroup stream * @apiGroup stream
* @apiName StreamStart * @apiName StreamStart
* @apiParam {String} url RTSP源地址 * @apiParam {String} url RTSP源地址
@ -65,7 +65,7 @@ func (h *APIHandler) StreamStart(c *gin.Context) {
} }
/** /**
* @api {get} /api/vi/stream/stop 停止拉流 * @api {get} /api/v1/stream/stop 停止推流
* @apiGroup stream * @apiGroup stream
* @apiName StreamStop * @apiName StreamStop
* @apiParam {String} id 拉流的ID * @apiParam {String} id 拉流的ID

10
routers/sys.go
View File

@ -99,7 +99,7 @@ func (h *APIHandler) ModifyPassword(c *gin.Context) {
} }
/** /**
* @api {get} /getserverinfo 获取平台运行信息 * @api {get} /api/v1/getserverinfo 获取平台运行信息
* @apiGroup sys * @apiGroup sys
* @apiName GetServerInfo * @apiName GetServerInfo
* @apiSuccess (200) {String} Hardware 硬件信息 * @apiSuccess (200) {String} Hardware 硬件信息
@ -122,7 +122,7 @@ func (h *APIHandler) GetServerInfo(c *gin.Context) {
} }
/** /**
* @api {get} /restart 重启服务 * @api {get} /api/v1/restart 重启服务
* @apiGroup sys * @apiGroup sys
* @apiName Restart * @apiName Restart
* @apiUse simpleSuccess * @apiUse simpleSuccess
@ -146,7 +146,7 @@ func (h *APIHandler) Restart(c *gin.Context) {
*/ */
/** /**
* @api {get} /login 登录 * @api {get} /api/v1/login 登录
* @apiGroup sys * @apiGroup sys
* @apiName Login * @apiName Login
* @apiParam {String} username 用户名 * @apiParam {String} username 用户名
@ -183,7 +183,7 @@ func (h *APIHandler) Login(c *gin.Context) {
} }
/** /**
* @api {get} /userInfo 获取当前登录用户信息 * @api {get} /api/v1/userInfo 获取当前登录用户信息
* @apiGroup sys * @apiGroup sys
* @apiName UserInfo * @apiName UserInfo
* @apiUse userInfo * @apiUse userInfo
@ -202,7 +202,7 @@ func (h *APIHandler) UserInfo(c *gin.Context) {
} }
/** /**
* @api {get} /logout 登出 * @api {get} /api/v1/logout 登出
* @apiGroup sys * @apiGroup sys
* @apiName Logout * @apiName Logout
* @apiUse simpleSuccess * @apiUse simpleSuccess

22
www/apidoc/api_data.js
View File

@ -1,7 +1,7 @@
define({ "api": [ define({ "api": [
{ {
"type": "get", "type": "get",
"url": "/api/vi/record/files", "url": "/api/v1/record/files",
"title": "获取所有录像文件", "title": "获取所有录像文件",
"group": "record", "group": "record",
"name": "RecordFiles", "name": "RecordFiles",
@ -104,7 +104,7 @@ define({ "api": [
}, },
{ {
"type": "get", "type": "get",
"url": "/api/vi/record/folders", "url": "/api/v1/record/folders",
"title": "获取所有录像文件夹", "title": "获取所有录像文件夹",
"group": "record", "group": "record",
"name": "RecordFolders", "name": "RecordFolders",
@ -427,8 +427,8 @@ define({ "api": [
}, },
{ {
"type": "get", "type": "get",
"url": "/api/vi/stream/start", "url": "/api/v1/stream/start",
"title": "启动拉流", "title": "启动拉转推",
"group": "stream", "group": "stream",
"name": "StreamStart", "name": "StreamStart",
"parameter": { "parameter": {
@ -484,8 +484,8 @@ define({ "api": [
}, },
{ {
"type": "get", "type": "get",
"url": "/api/vi/stream/stop", "url": "/api/v1/stream/stop",
"title": "停止拉流", "title": "停止推流",
"group": "stream", "group": "stream",
"name": "StreamStop", "name": "StreamStop",
"parameter": { "parameter": {
@ -516,7 +516,7 @@ define({ "api": [
}, },
{ {
"type": "get", "type": "get",
"url": "/getserverinfo", "url": "/api/v1/getserverinfo",
"title": "获取平台运行信息", "title": "获取平台运行信息",
"group": "sys", "group": "sys",
"name": "GetServerInfo", "name": "GetServerInfo",
@ -560,7 +560,7 @@ define({ "api": [
}, },
{ {
"type": "get", "type": "get",
"url": "/login", "url": "/api/v1/login",
"title": "登录", "title": "登录",
"group": "sys", "group": "sys",
"name": "Login", "name": "Login",
@ -599,7 +599,7 @@ define({ "api": [
}, },
{ {
"type": "get", "type": "get",
"url": "/logout", "url": "/api/v1/logout",
"title": "登出", "title": "登出",
"group": "sys", "group": "sys",
"name": "Logout", "name": "Logout",
@ -618,7 +618,7 @@ define({ "api": [
}, },
{ {
"type": "get", "type": "get",
"url": "/restart", "url": "/api/v1/restart",
"title": "重启服务", "title": "重启服务",
"group": "sys", "group": "sys",
"name": "Restart", "name": "Restart",
@ -637,7 +637,7 @@ define({ "api": [
}, },
{ {
"type": "get", "type": "get",
"url": "/userInfo", "url": "/api/v1/userInfo",
"title": "获取当前登录用户信息", "title": "获取当前登录用户信息",
"group": "sys", "group": "sys",
"name": "UserInfo", "name": "UserInfo",

22
www/apidoc/api_data.json
View File

@ -1,7 +1,7 @@
[ [
{ {
"type": "get", "type": "get",
"url": "/api/vi/record/files", "url": "/api/v1/record/files",
"title": "获取所有录像文件", "title": "获取所有录像文件",
"group": "record", "group": "record",
"name": "RecordFiles", "name": "RecordFiles",
@ -104,7 +104,7 @@
}, },
{ {
"type": "get", "type": "get",
"url": "/api/vi/record/folders", "url": "/api/v1/record/folders",
"title": "获取所有录像文件夹", "title": "获取所有录像文件夹",
"group": "record", "group": "record",
"name": "RecordFolders", "name": "RecordFolders",
@ -427,8 +427,8 @@
}, },
{ {
"type": "get", "type": "get",
"url": "/api/vi/stream/start", "url": "/api/v1/stream/start",
"title": "启动拉流", "title": "启动拉转推",
"group": "stream", "group": "stream",
"name": "StreamStart", "name": "StreamStart",
"parameter": { "parameter": {
@ -484,8 +484,8 @@
}, },
{ {
"type": "get", "type": "get",
"url": "/api/vi/stream/stop", "url": "/api/v1/stream/stop",
"title": "停止拉流", "title": "停止推流",
"group": "stream", "group": "stream",
"name": "StreamStop", "name": "StreamStop",
"parameter": { "parameter": {
@ -516,7 +516,7 @@
}, },
{ {
"type": "get", "type": "get",
"url": "/getserverinfo", "url": "/api/v1/getserverinfo",
"title": "获取平台运行信息", "title": "获取平台运行信息",
"group": "sys", "group": "sys",
"name": "GetServerInfo", "name": "GetServerInfo",
@ -560,7 +560,7 @@
}, },
{ {
"type": "get", "type": "get",
"url": "/login", "url": "/api/v1/login",
"title": "登录", "title": "登录",
"group": "sys", "group": "sys",
"name": "Login", "name": "Login",
@ -599,7 +599,7 @@
}, },
{ {
"type": "get", "type": "get",
"url": "/logout", "url": "/api/v1/logout",
"title": "登出", "title": "登出",
"group": "sys", "group": "sys",
"name": "Logout", "name": "Logout",
@ -618,7 +618,7 @@
}, },
{ {
"type": "get", "type": "get",
"url": "/restart", "url": "/api/v1/restart",
"title": "重启服务", "title": "重启服务",
"group": "sys", "group": "sys",
"name": "Restart", "name": "Restart",
@ -637,7 +637,7 @@
}, },
{ {
"type": "get", "type": "get",
"url": "/userInfo", "url": "/api/v1/userInfo",
"title": "获取当前登录用户信息", "title": "获取当前登录用户信息",
"group": "sys", "group": "sys",
"name": "UserInfo", "name": "UserInfo",

4
www/apidoc/api_project.js
View File

@ -25,8 +25,8 @@ define({
"apidoc": "0.3.0", "apidoc": "0.3.0",
"generator": { "generator": {
"name": "apidoc", "name": "apidoc",
"time": "2018-12-03T05:17:28.228Z", "time": "2018-12-03T05:50:19.289Z",
"url": "http://apidocjs.com", "url": "http://apidocjs.com",
"version": "0.17.6" "version": "0.17.7"
} }
}); });

4
www/apidoc/api_project.json
View File

@ -25,8 +25,8 @@
"apidoc": "0.3.0", "apidoc": "0.3.0",
"generator": { "generator": {
"name": "apidoc", "name": "apidoc",
"time": "2018-12-03T05:17:28.228Z", "time": "2018-12-03T05:50:19.289Z",
"url": "http://apidocjs.com", "url": "http://apidocjs.com",
"version": "0.17.6" "version": "0.17.7"
} }
} }

25
www/apidoc/locales/cs.js Normal file
View File

@ -0,0 +1,25 @@
define({
cs: {
'Allowed values:' : 'Povolené hodnoty:',
'Compare all with predecessor': 'Porovnat vše s předchozími verzemi',
'compare changes to:' : 'porovnat změny s:',
'compared to' : 'porovnat s',
'Default value:' : 'Výchozí hodnota:',
'Description' : 'Popis',
'Field' : 'Pole',
'General' : 'Obecné',
'Generated with' : 'Vygenerováno pomocí',
'Name' : 'Název',
'No response values.' : 'Nebyly vráceny žádné hodnoty.',
'optional' : 'volitelné',
'Parameter' : 'Parametr',
'Permission:' : 'Oprávnění:',
'Response' : 'Odpověď',
'Send' : 'Odeslat',
'Send a Sample Request' : 'Odeslat ukázkový požadavek',
'show up to version:' : 'zobrazit po verzi:',
'Size range:' : 'Rozsah velikosti:',
'Type' : 'Typ',
'url' : 'url'
}
});

1
www/apidoc/locales/locale.js
View File

@ -1,5 +1,6 @@
define([ define([
'./locales/ca.js', './locales/ca.js',
'./locales/cs.js',
'./locales/de.js', './locales/de.js',
'./locales/es.js', './locales/es.js',
'./locales/fr.js', './locales/fr.js',