diff --git a/app/Http/Controllers/Api/SystemController.php b/app/Http/Controllers/Api/SystemController.php index e40470d2..89307f5f 100755 --- a/app/Http/Controllers/Api/SystemController.php +++ b/app/Http/Controllers/Api/SystemController.php @@ -57,7 +57,7 @@ class SystemController extends AbstractController } /** - * @api {post} api/system/priority 01. 获取优先级、保存优先级 + * @api {post} api/system/priority 02. 获取优先级、保存优先级 * * @apiVersion 1.0.0 * @apiGroup system @@ -103,7 +103,7 @@ class SystemController extends AbstractController } /** - * @api {get} api/system/get/info 02. 获取终端详细信息 + * @api {get} api/system/get/info 03. 获取终端详细信息 * * @apiVersion 1.0.0 * @apiGroup system @@ -132,7 +132,7 @@ class SystemController extends AbstractController } /** - * @api {get} api/system/get/ip 03. 获取IP地址 + * @api {get} api/system/get/ip 04. 获取IP地址 * * @apiVersion 1.0.0 * @apiGroup system @@ -147,7 +147,7 @@ class SystemController extends AbstractController } /** - * @api {get} api/system/get/cnip 04. 是否中国IP地址 + * @api {get} api/system/get/cnip 05. 是否中国IP地址 * * @apiVersion 1.0.0 * @apiGroup system @@ -164,7 +164,7 @@ class SystemController extends AbstractController } /** - * @api {get} api/system/get/ipgcj02 05. 获取IP地址经纬度 + * @api {get} api/system/get/ipgcj02 06. 获取IP地址经纬度 * * @apiVersion 1.0.0 * @apiGroup system @@ -181,7 +181,7 @@ class SystemController extends AbstractController } /** - * @api {get} api/system/get/ipinfo 06. 获取IP地址详细信息 + * @api {get} api/system/get/ipinfo 07. 获取IP地址详细信息 * * @apiVersion 1.0.0 * @apiGroup system @@ -198,7 +198,7 @@ class SystemController extends AbstractController } /** - * @api {get} api/system/get/appinfo 06. 获取应用下载信息 + * @api {get} api/system/get/appinfo 08. 获取应用下载信息 * * @apiVersion 1.0.0 * @apiGroup system @@ -255,7 +255,7 @@ class SystemController extends AbstractController } /** - * @api {get} api/system/get/appdown 06. 下载应用 + * @api {get} api/system/get/appdown 09. 下载应用 * * @apiVersion 1.0.0 * @apiGroup system diff --git a/app/Http/Controllers/Api/UsersController.php b/app/Http/Controllers/Api/UsersController.php index 1ea1f985..647685c6 100755 --- a/app/Http/Controllers/Api/UsersController.php +++ b/app/Http/Controllers/Api/UsersController.php @@ -137,7 +137,7 @@ class UsersController extends AbstractController } /** - * @api {get} api/users/login/codejson 07. 验证码json + * @api {get} api/users/login/codejson 04. 验证码json * * @apiDescription 用于判断是否需要登录验证码 * @apiVersion 1.0.0 @@ -155,7 +155,7 @@ class UsersController extends AbstractController } /** - * @api {get} api/users/info 04. 获取我的信息 + * @api {get} api/users/info 05. 获取我的信息 * * @apiDescription 需要token身份 * @apiVersion 1.0.0 @@ -191,7 +191,7 @@ class UsersController extends AbstractController } /** - * @api {get} api/users/editdata 05. 修改自己的资料 + * @api {get} api/users/editdata 06. 修改自己的资料 * * @apiDescription 需要token身份 * @apiVersion 1.0.0 @@ -250,7 +250,7 @@ class UsersController extends AbstractController } /** - * @api {get} api/users/editpass 06. 修改自己的密码 + * @api {get} api/users/editpass 07. 修改自己的密码 * * @apiDescription 需要token身份 * @apiVersion 1.0.0 diff --git a/app/Http/Controllers/Api/apidoc.json b/app/Http/Controllers/Api/apidoc.json new file mode 100755 index 00000000..7b090181 --- /dev/null +++ b/app/Http/Controllers/Api/apidoc.json @@ -0,0 +1,10 @@ +{ + "name": "API", + "title": "APP接口", + "version": "1.0.0", + "description": "APP接口文档", + "url": "https://你的域名/", + "template": { + "withGenerator": false + } +} diff --git a/app/Http/Controllers/Api/apidoc.php b/app/Http/Controllers/Api/apidoc.php new file mode 100755 index 00000000..d15ef79f --- /dev/null +++ b/app/Http/Controllers/Api/apidoc.php @@ -0,0 +1,89 @@ +$text) { + if (in_array(strtolower($matchs[1][$key]), array('get', 'post'))) { + $expl = explode(" ", __sRemove($text)); + $end = $expl[1]; + if ($expl[2]) { + $end = ''; + foreach ($expl AS $k=>$v) { if ($k >= 2) { $end.= " ".$v; } } + } + $newtext = "* @api {".$matchs[1][$key]."} ".$expl[0]." ".__zeroFill($i, 2).". ".trim($end); + $content = str_replace("* @api {".$matchs[1][$key]."} ".$text, $newtext, $content); + $i++; + // + echo $newtext; + echo "\r\n"; + } + } + if ($i > 1) { + file_put_contents($fillPath, $content); + } + } +} +echo "Success \n"; + +/** ************************************************************** */ +/** ************************************************************** */ +/** ************************************************************** */ + +/** + * 替换所有空格 + * @param $str + * @return mixed + */ +function __sRemove($str) { + $str = str_replace(" ", " ", $str); + if (__strExists($str, " ")) { + return __sRemove($str); + } + return $str; +} + +/** + * 是否包含字符 + * @param $string + * @param $find + * @return bool + */ +function __strExists($string, $find) +{ + return str_contains($string, $find); +} + +/** + * @param string $str 补零 + * @param int $length + * @param int $after + * @return bool|string + */ +function __zeroFill($str, $length = 0, $after = 1) { + if (strlen($str) >= $length) { + return $str; + } + $_str = ''; + for ($i = 0; $i < $length; $i++) { + $_str .= '0'; + } + if ($after) { + $_ret = substr($_str . $str, $length * -1); + } else { + $_ret = substr($str . $_str, 0, $length); + } + return $_ret; +} diff --git a/package.json b/package.json index 9119a7eb..52331bca 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "DooTask", - "version": "0.3.14", + "version": "0.3.16", "description": "DooTask is task management system.", "scripts": { "start": "./cmd dev", diff --git a/public/docs/api_data.js b/public/docs/api_data.js new file mode 100644 index 00000000..8d3d889f --- /dev/null +++ b/public/docs/api_data.js @@ -0,0 +1,2608 @@ +define({ "api": [ + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "page", + "description": "
当前页,默认:1
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pagesize", + "description": "每页显示数量,默认:100,最大:200
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/DialogController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/DialogController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/DialogController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "dialog_id", + "description": "对话ID
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/DialogController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/DialogController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/DialogController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "userid", + "description": "对话会员ID
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/DialogController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/DialogController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/DialogController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "dialog_id", + "description": "对话ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "page", + "description": "当前页,默认:1
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pagesize", + "description": "每页显示数量,默认:50,最大:100
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/DialogController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/DialogController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/DialogController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "dialog_id", + "description": "对话ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "text", + "description": "消息内容
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/DialogController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/DialogController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/DialogController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "dialog_id", + "description": "对话ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "filename", + "description": "post-文件名称
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "image64", + "description": "post-base64图片(二选一)
" + }, + { + "group": "Parameter", + "type": "File", + "optional": true, + "field": "files", + "description": "post-文件对象(二选一)
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/DialogController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/DialogController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/DialogController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "msg_id", + "description": "消息ID(需要是消息的发送人)
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/DialogController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/DialogController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/DialogController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pid", + "description": "父级ID
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/FileController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "key", + "description": "关键词
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/FileController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "name", + "description": "项目名称
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "type", + "description": "文件类型
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "id", + "description": "文件ID(赋值修改文件名称)
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pid", + "description": "父级ID
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/FileController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "文件ID
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/FileController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "文件ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "pid", + "description": "移动到的文件夹ID
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/FileController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "文件ID
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/FileController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "文件ID
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/FileController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "文件ID
" + }, + { + "group": "Parameter", + "type": "Object", + "optional": true, + "field": "D", + "description": "Request Payload 提交
文件ID
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/FileController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pid", + "description": "父级ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "files", + "description": "文件名
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/FileController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "文件ID
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/FileController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "文件ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "action", + "description": "动作
共享对象
共享成员,格式: [userid1, userid2, userid3]
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/FileController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "all", + "description": "是否查看所有项目(限制管理员)
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "archived", + "description": "归档状态
搜索条件
当前页,默认:1
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pagesize", + "description": "每页显示数量,默认:100,最大:200
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "name", + "description": "项目名称
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "desc", + "description": "项目介绍
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "columns", + "description": "列表,格式:列表名称1,列表名称2
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "name", + "description": "项目名称
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "desc", + "description": "项目介绍
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "userid", + "description": "成员ID 或 成员ID组
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "owner_userid", + "description": "新的项目负责人ID
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "Object", + "optional": false, + "field": "sort", + "description": "排序数据
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "only_column", + "description": "仅更新列表
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "type", + "description": "类型
项目ID
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "page", + "description": "当前页,默认:1
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pagesize", + "description": "每页显示数量,默认:100,最大:200
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "name", + "description": "列表名称
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "column_id", + "description": "列表ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "name", + "description": "列表名称
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "color", + "description": "颜色
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "column_id", + "description": "列表ID(留空为添加列表)
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "parent_id", + "description": "主任务ID(填写此项时 project_id 参数无效)
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "name", + "description": "任务描述关键词
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "time", + "description": "指定时间范围,如:['2020-12-12', '2020-12-30']
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "time_before", + "description": "指定时间之前,如:2020-12-30 00:00:00(填写此项时 time 参数无效)
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "complete", + "description": "完成状态
归档状态
任务ID
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "task_id", + "description": "任务ID
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "task_id", + "description": "任务ID
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "file_id", + "description": "文件ID
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "mixed", + "optional": true, + "field": "column_id", + "description": "列表ID,任意值自动创建,留空取第一个
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "name", + "description": "任务描述
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "content", + "description": "任务详情
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "times", + "description": "计划时间(格式:开始时间,结束时间;如:2020-01-01 00:00,2020-01-01 23:59)
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "owner", + "description": "负责人
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "subtasks", + "description": "子任务(格式:[{name,owner,times}])
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "top", + "description": "添加的任务排到列表最前面
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "task_id", + "description": "任务ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "name", + "description": "任务描述
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "task_id", + "description": "任务ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "name", + "description": "任务描述
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "times", + "description": "计划时间(格式:开始时间,结束时间;如:2020-01-01 00:00,2020-01-01 23:59)
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "owner", + "description": "修改负责人
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "content", + "description": "任务详情(子任务不支持)
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "color", + "description": "背景色(子任务不支持)
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "assist", + "description": "修改协助人员(子任务不支持)
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "p_level", + "description": "优先级相关(子任务不支持)
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "p_name", + "description": "优先级相关(子任务不支持)
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "p_color", + "description": "优先级相关(子任务不支持)
" + }, + { + "group": "Parameter", + "type": "String|false", + "optional": true, + "field": "complete_at", + "description": "完成时间(如:2020-01-01 00:00,false表示未完成)
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "task_id", + "description": "任务ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "filename", + "description": "post-文件名称
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "image64", + "description": "post-base64图片(二选一)
" + }, + { + "group": "Parameter", + "type": "File", + "optional": true, + "field": "files", + "description": "post-文件对象(二选一)
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "task_id", + "description": "任务ID
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "task_id", + "description": "任务ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "type", + "description": "类型
任务ID
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "task_id", + "description": "任务ID(与 项目ID 二选一,任务ID优先)
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "page", + "description": "当前页,默认:1
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pagesize", + "description": "每页显示数量,默认:20,最大:100
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Object", + "optional": true, + "field": "keys", + "description": "搜索条件
当前页,默认:1
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pagesize", + "description": "每页显示数量,默认:20,最大:50
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/UsersController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/UsersController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/UsersController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "userid", + "description": "会员ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "type", + "description": "操作
新的密码
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "nickname", + "description": "昵称
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "profession", + "description": "职位
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/UsersController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/UsersController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/UsersController.php", + "name": "" + }, + { + "type": "post", + "url": "api/system/fileupload", + "title": "12. 上传文件", + "description": "需要token身份
", + "version": "1.0.0", + "group": "system", + "name": "fileupload", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "image64", + "description": "图片base64
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "filename", + "description": "文件名
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "files", + "description": "文件名
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/get/appdown", + "title": "09. 下载应用", + "version": "1.0.0", + "group": "system", + "name": "get__appdown", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "file", + "description": "文件名称
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/get/appinfo", + "title": "08. 获取应用下载信息", + "version": "1.0.0", + "group": "system", + "name": "get__appinfo", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/get/cnip", + "title": "05. 是否中国IP地址", + "version": "1.0.0", + "group": "system", + "name": "get__cnip", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "ip", + "description": "IP值
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/get/info", + "title": "03. 获取终端详细信息", + "version": "1.0.0", + "group": "system", + "name": "get__info", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "key", + "description": "key值
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/get/ip", + "title": "04. 获取IP地址", + "version": "1.0.0", + "group": "system", + "name": "get__ip", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/get/ipgcj02", + "title": "06. 获取IP地址经纬度", + "version": "1.0.0", + "group": "system", + "name": "get__ipgcj02", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "ip", + "description": "IP值
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/get/ipinfo", + "title": "07. 获取IP地址详细信息", + "version": "1.0.0", + "group": "system", + "name": "get__ipinfo", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "ip", + "description": "IP值
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "post", + "url": "api/system/imgupload", + "title": "10. 上传图片", + "description": "需要token身份
", + "version": "1.0.0", + "group": "system", + "name": "imgupload", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "image64", + "description": "图片base64
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "filename", + "description": "文件名
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/get/imgview", + "title": "11. 浏览图片空间", + "description": "需要token身份
", + "version": "1.0.0", + "group": "system", + "name": "imgview", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "path", + "description": "路径
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "post", + "url": "api/system/priority", + "title": "02. 获取优先级、保存优先级", + "version": "1.0.0", + "group": "system", + "name": "priority", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Array", + "optional": false, + "field": "list", + "description": "优先级数据,格式:[{name,color,days,priority}]
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/setting", + "title": "01. 获取设置、保存设置", + "version": "1.0.0", + "group": "system", + "name": "setting", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "type", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/users/basic", + "title": "09. 获取指定会员基础信息", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "basic", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "userid", + "description": "会员ID(多个格式:jsonArray,一次最多30个)
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/editdata", + "title": "06. 修改自己的资料", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "editdata", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Object", + "optional": true, + "field": "userimg", + "description": "会员头像(地址)
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "nickname", + "description": "昵称
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "profession", + "description": "职位/职称
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据(同"获取我的信息"接口)
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/editpass", + "title": "07. 修改自己的密码", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "editpass", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "oldpass", + "description": "旧密码
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "newpass", + "description": "新密码
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据(同"获取我的信息"接口)
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/info", + "title": "05. 获取我的信息", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "info", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + }, + "examples": [ + { + "title": "data:", + "content": "{\n \"userid\": 1,\n \"identity\": [ ],\n \"az\": \"\",\n \"email\": \"admin@admin.com\",\n \"nickname\": \"admin\",\n \"userimg\": \"\",\n \"login_num\": 10,\n \"changepass\": 0,\n \"last_ip\": \"10.22.22.1\",\n \"last_at\": \"2021-06-01 12:00:00\",\n \"line_ip\": \"10.22.22.1\",\n \"line_at\": \"2021-06-01 12:00:00\",\n \"created_ip\": \"\",\n}", + "type": "json" + } + ] + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/login", + "title": "01. 登录、注册", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "login", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "type", + "description": "类型
邮箱
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "password", + "description": "密码
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "code", + "description": "登录验证码
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "key", + "description": "登陆验证码key
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据(同"获取我的信息"接口)
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/login/codeimg", + "title": "03. 验证码图片", + "description": "用于判断是否需要登录验证码
", + "version": "1.0.0", + "group": "users", + "name": "login__codeimg", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "email", + "description": "用户名
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Image", + "optional": false, + "field": "data", + "description": "返回数据(直接输出图片)
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/login/codejson", + "title": "04. 验证码json", + "description": "用于判断是否需要登录验证码
", + "version": "1.0.0", + "group": "users", + "name": "login__codejson", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/login/needcode", + "title": "02. 是否需要验证码", + "description": "用于判断是否需要登录验证码
", + "version": "1.0.0", + "group": "users", + "name": "login__needcode", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "email", + "description": "用户名
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1需要、0不需要)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/search", + "title": "08. 搜索会员列表", + "description": "搜索会员列表
", + "version": "1.0.0", + "group": "users", + "name": "searchinfo", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Object", + "optional": false, + "field": "keys", + "description": "搜索条件
获取数量,10-100
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + } +] }); diff --git a/public/docs/api_data.json b/public/docs/api_data.json new file mode 100644 index 00000000..008f8386 --- /dev/null +++ b/public/docs/api_data.json @@ -0,0 +1,2608 @@ +[ + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "page", + "description": "当前页,默认:1
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pagesize", + "description": "每页显示数量,默认:100,最大:200
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/DialogController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/DialogController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/DialogController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "dialog_id", + "description": "对话ID
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/DialogController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/DialogController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/DialogController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "userid", + "description": "对话会员ID
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/DialogController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/DialogController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/DialogController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "dialog_id", + "description": "对话ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "page", + "description": "当前页,默认:1
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pagesize", + "description": "每页显示数量,默认:50,最大:100
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/DialogController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/DialogController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/DialogController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "dialog_id", + "description": "对话ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "text", + "description": "消息内容
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/DialogController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/DialogController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/DialogController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "dialog_id", + "description": "对话ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "filename", + "description": "post-文件名称
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "image64", + "description": "post-base64图片(二选一)
" + }, + { + "group": "Parameter", + "type": "File", + "optional": true, + "field": "files", + "description": "post-文件对象(二选一)
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/DialogController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/DialogController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/DialogController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "msg_id", + "description": "消息ID(需要是消息的发送人)
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/DialogController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/DialogController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/DialogController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pid", + "description": "父级ID
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/FileController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "key", + "description": "关键词
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/FileController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "name", + "description": "项目名称
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "type", + "description": "文件类型
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "id", + "description": "文件ID(赋值修改文件名称)
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pid", + "description": "父级ID
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/FileController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "文件ID
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/FileController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "文件ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "pid", + "description": "移动到的文件夹ID
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/FileController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "文件ID
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/FileController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "文件ID
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/FileController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "文件ID
" + }, + { + "group": "Parameter", + "type": "Object", + "optional": true, + "field": "D", + "description": "Request Payload 提交
文件ID
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/FileController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pid", + "description": "父级ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "files", + "description": "文件名
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/FileController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "文件ID
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/FileController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "文件ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "action", + "description": "动作
共享对象
共享成员,格式: [userid1, userid2, userid3]
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/FileController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/FileController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "all", + "description": "是否查看所有项目(限制管理员)
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "archived", + "description": "归档状态
搜索条件
当前页,默认:1
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pagesize", + "description": "每页显示数量,默认:100,最大:200
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "name", + "description": "项目名称
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "desc", + "description": "项目介绍
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "columns", + "description": "列表,格式:列表名称1,列表名称2
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "name", + "description": "项目名称
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "desc", + "description": "项目介绍
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "userid", + "description": "成员ID 或 成员ID组
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "owner_userid", + "description": "新的项目负责人ID
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "Object", + "optional": false, + "field": "sort", + "description": "排序数据
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "only_column", + "description": "仅更新列表
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "type", + "description": "类型
项目ID
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "page", + "description": "当前页,默认:1
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pagesize", + "description": "每页显示数量,默认:100,最大:200
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "name", + "description": "列表名称
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "column_id", + "description": "列表ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "name", + "description": "列表名称
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "color", + "description": "颜色
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "column_id", + "description": "列表ID(留空为添加列表)
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "parent_id", + "description": "主任务ID(填写此项时 project_id 参数无效)
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "name", + "description": "任务描述关键词
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "time", + "description": "指定时间范围,如:['2020-12-12', '2020-12-30']
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "time_before", + "description": "指定时间之前,如:2020-12-30 00:00:00(填写此项时 time 参数无效)
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "complete", + "description": "完成状态
归档状态
任务ID
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "task_id", + "description": "任务ID
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "task_id", + "description": "任务ID
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "file_id", + "description": "文件ID
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "mixed", + "optional": true, + "field": "column_id", + "description": "列表ID,任意值自动创建,留空取第一个
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "name", + "description": "任务描述
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "content", + "description": "任务详情
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "times", + "description": "计划时间(格式:开始时间,结束时间;如:2020-01-01 00:00,2020-01-01 23:59)
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "owner", + "description": "负责人
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "subtasks", + "description": "子任务(格式:[{name,owner,times}])
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "top", + "description": "添加的任务排到列表最前面
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "task_id", + "description": "任务ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "name", + "description": "任务描述
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "task_id", + "description": "任务ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "name", + "description": "任务描述
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "times", + "description": "计划时间(格式:开始时间,结束时间;如:2020-01-01 00:00,2020-01-01 23:59)
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "owner", + "description": "修改负责人
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "content", + "description": "任务详情(子任务不支持)
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "color", + "description": "背景色(子任务不支持)
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "assist", + "description": "修改协助人员(子任务不支持)
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "p_level", + "description": "优先级相关(子任务不支持)
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "p_name", + "description": "优先级相关(子任务不支持)
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "p_color", + "description": "优先级相关(子任务不支持)
" + }, + { + "group": "Parameter", + "type": "String|false", + "optional": true, + "field": "complete_at", + "description": "完成时间(如:2020-01-01 00:00,false表示未完成)
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "task_id", + "description": "任务ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "filename", + "description": "post-文件名称
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "image64", + "description": "post-base64图片(二选一)
" + }, + { + "group": "Parameter", + "type": "File", + "optional": true, + "field": "files", + "description": "post-文件对象(二选一)
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "task_id", + "description": "任务ID
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "task_id", + "description": "任务ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "type", + "description": "类型
任务ID
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "task_id", + "description": "任务ID(与 项目ID 二选一,任务ID优先)
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "page", + "description": "当前页,默认:1
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pagesize", + "description": "每页显示数量,默认:20,最大:100
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/ProjectController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/ProjectController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Object", + "optional": true, + "field": "keys", + "description": "搜索条件
当前页,默认:1
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pagesize", + "description": "每页显示数量,默认:20,最大:50
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/UsersController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/UsersController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/UsersController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "userid", + "description": "会员ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "type", + "description": "操作
新的密码
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "nickname", + "description": "昵称
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "profession", + "description": "职位
" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/UsersController.php", + "group": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/UsersController.php", + "groupTitle": "/Users/GAOER/wwwroot/dootask/app/Http/Controllers/Api/UsersController.php", + "name": "" + }, + { + "type": "post", + "url": "api/system/fileupload", + "title": "12. 上传文件", + "description": "需要token身份
", + "version": "1.0.0", + "group": "system", + "name": "fileupload", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "image64", + "description": "图片base64
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "filename", + "description": "文件名
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "files", + "description": "文件名
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/get/appdown", + "title": "09. 下载应用", + "version": "1.0.0", + "group": "system", + "name": "get__appdown", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "file", + "description": "文件名称
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/get/appinfo", + "title": "08. 获取应用下载信息", + "version": "1.0.0", + "group": "system", + "name": "get__appinfo", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/get/cnip", + "title": "05. 是否中国IP地址", + "version": "1.0.0", + "group": "system", + "name": "get__cnip", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "ip", + "description": "IP值
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/get/info", + "title": "03. 获取终端详细信息", + "version": "1.0.0", + "group": "system", + "name": "get__info", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "key", + "description": "key值
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/get/ip", + "title": "04. 获取IP地址", + "version": "1.0.0", + "group": "system", + "name": "get__ip", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/get/ipgcj02", + "title": "06. 获取IP地址经纬度", + "version": "1.0.0", + "group": "system", + "name": "get__ipgcj02", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "ip", + "description": "IP值
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/get/ipinfo", + "title": "07. 获取IP地址详细信息", + "version": "1.0.0", + "group": "system", + "name": "get__ipinfo", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "ip", + "description": "IP值
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "post", + "url": "api/system/imgupload", + "title": "10. 上传图片", + "description": "需要token身份
", + "version": "1.0.0", + "group": "system", + "name": "imgupload", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "image64", + "description": "图片base64
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "filename", + "description": "文件名
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/get/imgview", + "title": "11. 浏览图片空间", + "description": "需要token身份
", + "version": "1.0.0", + "group": "system", + "name": "imgview", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "path", + "description": "路径
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "post", + "url": "api/system/priority", + "title": "02. 获取优先级、保存优先级", + "version": "1.0.0", + "group": "system", + "name": "priority", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Array", + "optional": false, + "field": "list", + "description": "优先级数据,格式:[{name,color,days,priority}]
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/setting", + "title": "01. 获取设置、保存设置", + "version": "1.0.0", + "group": "system", + "name": "setting", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "type", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/users/basic", + "title": "09. 获取指定会员基础信息", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "basic", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "userid", + "description": "会员ID(多个格式:jsonArray,一次最多30个)
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/editdata", + "title": "06. 修改自己的资料", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "editdata", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Object", + "optional": true, + "field": "userimg", + "description": "会员头像(地址)
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "nickname", + "description": "昵称
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "profession", + "description": "职位/职称
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据(同"获取我的信息"接口)
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/editpass", + "title": "07. 修改自己的密码", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "editpass", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "oldpass", + "description": "旧密码
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "newpass", + "description": "新密码
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据(同"获取我的信息"接口)
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/info", + "title": "05. 获取我的信息", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "info", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + }, + "examples": [ + { + "title": "data:", + "content": "{\n \"userid\": 1,\n \"identity\": [ ],\n \"az\": \"\",\n \"email\": \"admin@admin.com\",\n \"nickname\": \"admin\",\n \"userimg\": \"\",\n \"login_num\": 10,\n \"changepass\": 0,\n \"last_ip\": \"10.22.22.1\",\n \"last_at\": \"2021-06-01 12:00:00\",\n \"line_ip\": \"10.22.22.1\",\n \"line_at\": \"2021-06-01 12:00:00\",\n \"created_ip\": \"\",\n}", + "type": "json" + } + ] + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/login", + "title": "01. 登录、注册", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "login", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "type", + "description": "类型
邮箱
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "password", + "description": "密码
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "code", + "description": "登录验证码
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "key", + "description": "登陆验证码key
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据(同"获取我的信息"接口)
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/login/codeimg", + "title": "03. 验证码图片", + "description": "用于判断是否需要登录验证码
", + "version": "1.0.0", + "group": "users", + "name": "login__codeimg", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "email", + "description": "用户名
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Image", + "optional": false, + "field": "data", + "description": "返回数据(直接输出图片)
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/login/codejson", + "title": "04. 验证码json", + "description": "用于判断是否需要登录验证码
", + "version": "1.0.0", + "group": "users", + "name": "login__codejson", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/login/needcode", + "title": "02. 是否需要验证码", + "description": "用于判断是否需要登录验证码
", + "version": "1.0.0", + "group": "users", + "name": "login__needcode", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "email", + "description": "用户名
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1需要、0不需要)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/search", + "title": "08. 搜索会员列表", + "description": "搜索会员列表
", + "version": "1.0.0", + "group": "users", + "name": "searchinfo", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Object", + "optional": false, + "field": "keys", + "description": "搜索条件
获取数量,10-100
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + } +] diff --git a/public/docs/api_project.js b/public/docs/api_project.js new file mode 100644 index 00000000..04c1a674 --- /dev/null +++ b/public/docs/api_project.js @@ -0,0 +1,19 @@ +define({ + "name": "API", + "version": "1.0.0", + "description": "APP接口文档", + "title": "APP接口", + "url": "https://你的域名/", + "template": { + "withGenerator": false + }, + "sampleUrl": false, + "defaultVersion": "0.0.0", + "apidoc": "0.3.0", + "generator": { + "name": "apidoc", + "time": "2021-08-29T03:25:22.530Z", + "url": "https://apidocjs.com", + "version": "0.25.0" + } +}); diff --git a/public/docs/api_project.json b/public/docs/api_project.json new file mode 100644 index 00000000..388bced7 --- /dev/null +++ b/public/docs/api_project.json @@ -0,0 +1,19 @@ +{ + "name": "API", + "version": "1.0.0", + "description": "APP接口文档", + "title": "APP接口", + "url": "https://你的域名/", + "template": { + "withGenerator": false + }, + "sampleUrl": false, + "defaultVersion": "0.0.0", + "apidoc": "0.3.0", + "generator": { + "name": "apidoc", + "time": "2021-08-29T03:25:22.530Z", + "url": "https://apidocjs.com", + "version": "0.25.0" + } +} diff --git a/public/docs/css/style.css b/public/docs/css/style.css new file mode 100644 index 00000000..7e111394 --- /dev/null +++ b/public/docs/css/style.css @@ -0,0 +1,529 @@ +/* ------------------------------------------------------------------------------------------ + * Content + * ------------------------------------------------------------------------------------------ */ +body { + max-width: 1280px; +} + +body, p, a, div, th, td { + font-family: "Source Sans Pro", sans-serif; + font-weight: 400; + font-size: 16px; +} + +@media (min-width: 1200px) { + body.container-fluid { + padding-right: 0px; + padding-left: 0px; + margin-right: 0px; + margin-left: 0px; + } +} + +td.code { + font-size: 14px; + font-family: "Source Code Pro", monospace; + font-style: normal; + font-weight: 400; +} + +#content { + padding-top: 16px; + z-Index: -1; + margin-left: 270px; +} + +p { + color: #808080; +} + +h1 { + font-family: "Source Sans Pro Semibold", sans-serif; + font-weight: normal; + font-size: 44px; + line-height: 50px; + margin: 0 0 10px 0; + padding: 0; +} + +h2 { + font-family: "Source Sans Pro", sans-serif; + font-weight: normal; + font-size: 24px; + line-height: 40px; + margin: 0 0 20px 0; + padding: 0; +} + +section { + border-top: 1px solid #ebebeb; + padding: 30px 0; +} + +section h1 { + font-family: "Source Sans Pro", sans-serif; + font-weight: 700; + font-size: 32px; + line-height: 40px; + padding-bottom: 14px; + margin: 0 0 20px 0; + padding: 0; +} + +article { + padding: 14px 0 30px 0; +} + +article h1 { + font-family: "Source Sans Pro Bold", sans-serif; + font-weight: 600; + font-size: 24px; + line-height: 26px; +} + +article h2 { + font-family: "Source Sans Pro", sans-serif; + font-weight: 600; + font-size: 18px; + line-height: 24px; + margin: 0 0 10px 0; +} + +article h3 { + font-family: "Source Sans Pro", sans-serif; + font-weight: 600; + font-size: 16px; + line-height: 18px; + margin: 0 0 10px 0; +} + +article h4 { + font-family: "Source Sans Pro", sans-serif; + font-weight: 600; + font-size: 14px; + line-height: 16px; + margin: 0 0 8px 0; +} + +table { + border-collapse: collapse; + width: 100%; + margin: 0 0 20px 0; +} + +th { + background-color: #f5f5f5; + text-align: left; + font-family: "Source Sans Pro", sans-serif; + font-weight: 700; + padding: 4px 8px; + border: #e0e0e0 1px solid; +} + +td { + vertical-align: top; + padding: 10px 8px 0 8px; + border: #e0e0e0 1px solid; +} + +#generator .content { + color: #b0b0b0; + border-top: 1px solid #ebebeb; + padding: 10px 0; +} + +.label-optional { + float: right; + background-color: grey; + margin-top: 4px; +} + +.open-left { + right: 0; + left: auto; +} + +/* ------------------------------------------------------------------------------------------ + * apidoc - intro + * ------------------------------------------------------------------------------------------ */ + +#apidoc .apidoc { + border-top: 1px solid #ebebeb; + padding: 30px 0; +} + +#apidoc h1 { + font-family: "Source Sans Pro", sans-serif; + font-weight: 700; + font-size: 32px; + line-height: 40px; + padding-bottom: 14px; + margin: 0 0 20px 0; + padding: 0; +} + +#apidoc h2 { + font-family: "Source Sans Pro Bold", sans-serif; + font-weight: 600; + font-size: 22px; + line-height: 26px; + padding-top: 14px; +} + +/* ------------------------------------------------------------------------------------------ + * Request type + * ------------------------------------------------------------------------------------------ */ +.type { + font-family: "Source Sans Pro", sans-serif; + font-weight: 600; + font-size: 15px; + display: inline-block; + margin: 0 0 5px 0; + padding: 4px 5px; + border-radius: 6px; + text-transform: uppercase; + background-color: #3387CC; + color: #ffffff; +} + +.type__get { + background-color: green; +} + +.type__put { + background-color: #e5c500; +} + +.type__post { + background-color: #4070ec; +} + +.type__delete { + background-color: #ed0039; +} + +/* ------------------------------------------------------------------------------------------ + * Sidenav + * ------------------------------------------------------------------------------------------ */ +.sidenav { + width: 228px; + margin: 0; + padding: 0 20px 20px 20px; + position: fixed; + top: 50px; + left: 0; + bottom: 0; + overflow-x: hidden; + overflow-y: auto; + background-color: #f5f5f5; + z-index: 10; +} + +.sidenav > li > a { + display: block; + width: 192px; + margin: 0; + padding: 2px 11px; + border: 0; + border-left: transparent 4px solid; + border-right: transparent 4px solid; + font-family: "Source Sans Pro", sans-serif; + font-weight: 400; + font-size: 14px; + overflow: hidden; + text-overflow:ellipsis; + white-space: nowrap; +} + +.sidenav > li.nav-header { + margin-top: 8px; + margin-bottom: 8px; +} + +.sidenav > li.nav-header > a { + padding: 5px 15px; + border: 1px solid #e5e5e5; + width: 190px; + font-family: "Source Sans Pro", sans-serif; + font-weight: 700; + font-size: 16px; + background-color: #ffffff; +} + +.sidenav > li.active > a { + position: relative; + z-index: 2; + background-color: #0088cc; + color: #ffffff; +} + +.sidenav > li.has-modifications a { + border-right: #60d060 4px solid; +} + +.sidenav > li.is-new a { + border-left: #e5e5e5 4px solid; +} + +/* ------------------------------------------------------------------------------------------ + * Side nav search + * ------------------------------------------------------------------------------------------ */ +.sidenav-search { + width: 228px; + left: 0px; + position: fixed; + padding: 16px 20px 10px 20px; + background-color: #F5F5F5; + z-index: 11; +} + +.sidenav-search .search { + height: 26px; +} + +.search-reset { + position: absolute; + display: block; + cursor: pointer; + width: 20px; + height: 20px; + text-align: center; + right: 28px; + top: 17px; + background-color: #fff; +} + +/* ------------------------------------------------------------------------------------------ + * Compare + * ------------------------------------------------------------------------------------------ */ + +ins { + background: #60d060; + text-decoration: none; + color: #000000; +} + +del { + background: #f05050; + color: #000000; +} + +.label-ins { + background-color: #60d060; +} + +.label-del { + background-color: #f05050; + text-decoration: line-through; +} + +pre.ins { + background-color: #60d060; +} + +pre.del { + background-color: #f05050; + text-decoration: line-through; +} + +table.ins th, +table.ins td { + background-color: #60d060; +} + +table.del th, +table.del td { + background-color: #f05050; + text-decoration: line-through; +} + +tr.ins td { + background-color: #60d060; +} + +tr.del td { + background-color: #f05050; + text-decoration: line-through; +} + +/* ------------------------------------------------------------------------------------------ + * Spinner + * ------------------------------------------------------------------------------------------ */ + +#loader { + position: absolute; + width: 100%; +} + +#loader p { + padding-top: 80px; + margin-left: -4px; +} + +.spinner { + margin: 200px auto; + width: 60px; + height: 60px; + position: relative; +} + +.container1 > div, .container2 > div, .container3 > div { + width: 14px; + height: 14px; + background-color: #0088cc; + + border-radius: 100%; + position: absolute; + -webkit-animation: bouncedelay 1.2s infinite ease-in-out; + animation: bouncedelay 1.2s infinite ease-in-out; + /* Prevent first frame from flickering when animation starts */ + -webkit-animation-fill-mode: both; + animation-fill-mode: both; +} + +.spinner .spinner-container { + position: absolute; + width: 100%; + height: 100%; +} + +.container2 { + -webkit-transform: rotateZ(45deg); + transform: rotateZ(45deg); +} + +.container3 { + -webkit-transform: rotateZ(90deg); + transform: rotateZ(90deg); +} + +.circle1 { top: 0; left: 0; } +.circle2 { top: 0; right: 0; } +.circle3 { right: 0; bottom: 0; } +.circle4 { left: 0; bottom: 0; } + +.container2 .circle1 { + -webkit-animation-delay: -1.1s; + animation-delay: -1.1s; +} + +.container3 .circle1 { + -webkit-animation-delay: -1.0s; + animation-delay: -1.0s; +} + +.container1 .circle2 { + -webkit-animation-delay: -0.9s; + animation-delay: -0.9s; +} + +.container2 .circle2 { + -webkit-animation-delay: -0.8s; + animation-delay: -0.8s; +} + +.container3 .circle2 { + -webkit-animation-delay: -0.7s; + animation-delay: -0.7s; +} + +.container1 .circle3 { + -webkit-animation-delay: -0.6s; + animation-delay: -0.6s; +} + +.container2 .circle3 { + -webkit-animation-delay: -0.5s; + animation-delay: -0.5s; +} + +.container3 .circle3 { + -webkit-animation-delay: -0.4s; + animation-delay: -0.4s; +} + +.container1 .circle4 { + -webkit-animation-delay: -0.3s; + animation-delay: -0.3s; +} + +.container2 .circle4 { + -webkit-animation-delay: -0.2s; + animation-delay: -0.2s; +} + +.container3 .circle4 { + -webkit-animation-delay: -0.1s; + animation-delay: -0.1s; +} + +@-webkit-keyframes bouncedelay { + 0%, 80%, 100% { -webkit-transform: scale(0.0) } + 40% { -webkit-transform: scale(1.0) } +} + +@keyframes bouncedelay { + 0%, 80%, 100% { + transform: scale(0.0); + -webkit-transform: scale(0.0); + } 40% { + transform: scale(1.0); + -webkit-transform: scale(1.0); + } +} + +/* ------------------------------------------------------------------------------------------ + * Tabs + * ------------------------------------------------------------------------------------------ */ +ul.nav-tabs { + margin: 0; +} + +p.deprecated span{ + color: #ff0000; + font-weight: bold; + text-decoration: underline; +} + +/* ------------------------------------------------------------------------------------------ + * Print + * ------------------------------------------------------------------------------------------ */ + +@media print { + + #sidenav, + #version, + #versions, + section .version, + section .versions { + display: none; + } + + #content { + margin-left: 0; + } + + a { + text-decoration: none; + color: inherit; + } + + a:after { + content: " [" attr(href) "] "; + } + + p { + color: #000000 + } + + pre { + background-color: #ffffff; + color: #000000; + padding: 10px; + border: #808080 1px solid; + border-radius: 6px; + position: relative; + margin: 10px 0 20px 0; + } + +} /* /@media print */ diff --git a/public/docs/fonts/glyphicons-halflings-regular.eot b/public/docs/fonts/glyphicons-halflings-regular.eot new file mode 100644 index 00000000..b93a4953 Binary files /dev/null and b/public/docs/fonts/glyphicons-halflings-regular.eot differ diff --git a/public/docs/fonts/glyphicons-halflings-regular.svg b/public/docs/fonts/glyphicons-halflings-regular.svg new file mode 100644 index 00000000..94fb5490 --- /dev/null +++ b/public/docs/fonts/glyphicons-halflings-regular.svg @@ -0,0 +1,288 @@ + + + \ No newline at end of file diff --git a/public/docs/fonts/glyphicons-halflings-regular.ttf b/public/docs/fonts/glyphicons-halflings-regular.ttf new file mode 100644 index 00000000..1413fc60 Binary files /dev/null and b/public/docs/fonts/glyphicons-halflings-regular.ttf differ diff --git a/public/docs/fonts/glyphicons-halflings-regular.woff b/public/docs/fonts/glyphicons-halflings-regular.woff new file mode 100644 index 00000000..9e612858 Binary files /dev/null and b/public/docs/fonts/glyphicons-halflings-regular.woff differ diff --git a/public/docs/fonts/glyphicons-halflings-regular.woff2 b/public/docs/fonts/glyphicons-halflings-regular.woff2 new file mode 100644 index 00000000..64539b54 Binary files /dev/null and b/public/docs/fonts/glyphicons-halflings-regular.woff2 differ diff --git a/public/docs/img/favicon.ico b/public/docs/img/favicon.ico new file mode 100644 index 00000000..c307a043 Binary files /dev/null and b/public/docs/img/favicon.ico differ diff --git a/public/docs/index.html b/public/docs/index.html new file mode 100644 index 00000000..82ac4366 --- /dev/null +++ b/public/docs/index.html @@ -0,0 +1,692 @@ + + + + +Loading...
+l.reach&&(l.reach=j);var C=y.prev;L&&(C=I(t,C,L),k+=L.length),z(t,C,x);var _=new W(o,g?M.tokenize(O,g):O,v,O);y=I(t,C,_),N&&I(t,y,N),1r)return null;var i=t?n[j]:n[w];if(!i.test(e))return null;try{return new K(e,t)}catch(s){return null}}e.valid=H;function H(e,r){var t=D(e,r);return t?t.version:null}e.clean=J;function J(e,r){var t=D(e.trim().replace(/^[=v]+/,""),r);return t?t.version:null}e.SemVer=K;function K(e,i){if(e instanceof K){if(e.loose===i)return e;else e=e.version}else if(typeof e!=="string"){throw new TypeError("Invalid Version: "+e)}if(e.length>r)throw new TypeError("version is longer than "+r+" characters");if(!(this instanceof K))return new K(e,i);this.loose=i;var s=e.trim().match(i?n[j]:n[w]);if(!s)throw new TypeError("Invalid Version: "+e);this.raw=e;this.major=+s[1];this.minor=+s[2];this.patch=+s[3];if(this.major>t||this.major<0)throw new TypeError("Invalid major version");if(this.minor>t||this.minor<0)throw new TypeError("Invalid minor version");if(this.patch>t||this.patch<0)throw new TypeError("Invalid patch version");if(!s[4])this.prerelease=[];else this.prerelease=s[4].split(".").map(function(e){if(/^[0-9]+$/.test(e)){var r=+e;if(r>=0&&r