github/dootask
1
0
Fork 0
mirror of https://github.com/kuaifan/dootask.git synced 2026-03-13 15:20:55 +00:00
Code Issues Packages Projects Releases Wiki Activity
dootask/public/docs/api_data.json
kuaifan 5fb9a5296a doc
2021-08-29 11:26:04 +08:00

2609 lines
72 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

[
{
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "page",
"description": "<p>当前页，默认:1</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "pagesize",
"description": "<p>每页显示数量，默认:100，最大:200</p>"
}
]
}
},
"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": "<p>对话ID</p>"
}
]
}
},
"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": "<p>对话会员ID</p>"
}
]
}
},
"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": "<p>对话ID</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "page",
"description": "<p>当前页，默认:1</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "pagesize",
"description": "<p>每页显示数量，默认:50，最大:100</p>"
}
]
}
},
"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": "<p>对话ID</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "text",
"description": "<p>消息内容</p>"
}
]
}
},
"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": "<p>对话ID</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "filename",
"description": "<p>post-文件名称</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "image64",
"description": "<p>post-base64图片（二选一）</p>"
},
{
"group": "Parameter",
"type": "File",
"optional": true,
"field": "files",
"description": "<p>post-文件对象（二选一）</p>"
}
]
}
},
"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": "<p>消息ID（需要是消息的发送人）</p>"
}
]
}
},
"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": "<p>父级ID</p>"
}
]
}
},
"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": "<p>关键词</p>"
}
]
}
},
"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": "<p>项目名称</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "type",
"description": "<p>文件类型</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "id",
"description": "<p>文件ID（赋值修改文件名称）</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "pid",
"description": "<p>父级ID</p>"
}
]
}
},
"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": "<p>文件ID</p>"
}
]
}
},
"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": "<p>文件ID</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": false,
"field": "pid",
"description": "<p>移动到的文件夹ID</p>"
}
]
}
},
"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": "<p>文件ID</p>"
}
]
}
},
"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": "<p>文件ID</p>"
}
]
}
},
"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": "<p>文件ID</p>"
},
{
"group": "Parameter",
"type": "Object",
"optional": true,
"field": "D",
"description": "<p>Request Payload 提交</p> <ul> <li>content: 内容</li> </ul>"
}
]
}
},
"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": "<p>文件ID</p>"
}
]
}
},
"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": "<p>父级ID</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "files",
"description": "<p>文件名</p>"
}
]
}
},
"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": "<p>文件ID</p>"
}
]
}
},
"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": "<p>文件ID</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "action",
"description": "<p>动作</p> <ul> <li>share: 设置共享</li> <li>unshare: 取消共享</li> </ul>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "share",
"description": "<p>共享对象</p> <ul> <li>1: 共享给所有人（限管理员）</li> <li>2: 共享给指定成员</li> </ul>"
},
{
"group": "Parameter",
"type": "Array",
"optional": true,
"field": "userids",
"description": "<p>共享成员，格式: [userid1, userid2, userid3]</p>"
}
]
}
},
"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": "<p>是否查看所有项目（限制管理员）</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "archived",
"description": "<p>归档状态</p> <ul> <li>all：全部</li> <li>no：未归档（默认）</li> <li>yes：已归档</li> </ul>"
},
{
"group": "Parameter",
"type": "Object",
"optional": true,
"field": "keys",
"description": "<p>搜索条件</p> <ul> <li>keys.name 项目名称</li> </ul>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "page",
"description": "<p>当前页，默认:1</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "pagesize",
"description": "<p>每页显示数量，默认:100，最大:200</p>"
}
]
}
},
"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": "<p>项目ID</p>"
}
]
}
},
"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": "<p>项目名称</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "desc",
"description": "<p>项目介绍</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "columns",
"description": "<p>列表，格式：列表名称1,列表名称2</p>"
}
]
}
},
"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": "<p>项目ID</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "name",
"description": "<p>项目名称</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "desc",
"description": "<p>项目介绍</p>"
}
]
}
},
"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": "<p>项目ID</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": false,
"field": "userid",
"description": "<p>成员ID 或 成员ID组</p>"
}
]
}
},
"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": "<p>项目ID</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": false,
"field": "owner_userid",
"description": "<p>新的项目负责人ID</p>"
}
]
}
},
"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": "<p>项目ID</p>"
},
{
"group": "Parameter",
"type": "Object",
"optional": false,
"field": "sort",
"description": "<p>排序数据</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "only_column",
"description": "<p>仅更新列表</p>"
}
]
}
},
"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": "<p>项目ID</p>"
}
]
}
},
"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": "<p>项目ID</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "type",
"description": "<p>类型</p> <ul> <li>add：归档（默认）</li> <li>recovery：还原归档</li> </ul>"
}
]
}
},
"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": "<p>项目ID</p>"
}
]
}
},
"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": "<p>项目ID</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "page",
"description": "<p>当前页，默认:1</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "pagesize",
"description": "<p>每页显示数量，默认:100，最大:200</p>"
}
]
}
},
"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": "<p>项目ID</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "name",
"description": "<p>列表名称</p>"
}
]
}
},
"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": "<p>列表ID</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "name",
"description": "<p>列表名称</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "color",
"description": "<p>颜色</p>"
}
]
}
},
"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": "<p>列表ID（留空为添加列表）</p>"
}
]
}
},
"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": "<p>项目ID</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "parent_id",
"description": "<p>主任务ID（填写此项时 project_id 参数无效）</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "name",
"description": "<p>任务描述关键词</p>"
},
{
"group": "Parameter",
"type": "Array",
"optional": true,
"field": "time",
"description": "<p>指定时间范围，如：['2020-12-12', '2020-12-30']</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "time_before",
"description": "<p>指定时间之前，如：2020-12-30 00:00:00（填写此项时 time 参数无效）</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "complete",
"description": "<p>完成状态</p> <ul> <li>all：所有（默认）</li> <li>yes：已完成</li> <li>no：未完成</li> </ul>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "archived",
"description": "<p>归档状态</p> <ul> <li>yes：已归档</li> <li>no：未归档（默认）</li> </ul>"
}
]
}
},
"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": "<p>任务ID</p>"
}
]
}
},
"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": "<p>任务ID</p>"
}
]
}
},
"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": "<p>任务ID</p>"
}
]
}
},
"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": "<p>文件ID</p>"
}
]
}
},
"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": "<p>项目ID</p>"
},
{
"group": "Parameter",
"type": "mixed",
"optional": true,
"field": "column_id",
"description": "<p>列表ID，任意值自动创建，留空取第一个</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "name",
"description": "<p>任务描述</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "content",
"description": "<p>任务详情</p>"
},
{
"group": "Parameter",
"type": "Array",
"optional": true,
"field": "times",
"description": "<p>计划时间（格式：开始时间,结束时间；如：2020-01-01 00:00,2020-01-01 23:59）</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "owner",
"description": "<p>负责人</p>"
},
{
"group": "Parameter",
"type": "Array",
"optional": true,
"field": "subtasks",
"description": "<p>子任务（格式：[{name,owner,times}]）</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "top",
"description": "<p>添加的任务排到列表最前面</p>"
}
]
}
},
"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": "<p>任务ID</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "name",
"description": "<p>任务描述</p>"
}
]
}
},
"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": "<p>任务ID</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "name",
"description": "<p>任务描述</p>"
},
{
"group": "Parameter",
"type": "Array",
"optional": true,
"field": "times",
"description": "<p>计划时间（格式：开始时间,结束时间；如：2020-01-01 00:00,2020-01-01 23:59）</p>"
},
{
"group": "Parameter",
"type": "Array",
"optional": true,
"field": "owner",
"description": "<p>修改负责人</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "content",
"description": "<p>任务详情（子任务不支持）</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "color",
"description": "<p>背景色（子任务不支持）</p>"
},
{
"group": "Parameter",
"type": "Array",
"optional": true,
"field": "assist",
"description": "<p>修改协助人员（子任务不支持）</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "p_level",
"description": "<p>优先级相关（子任务不支持）</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "p_name",
"description": "<p>优先级相关（子任务不支持）</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "p_color",
"description": "<p>优先级相关（子任务不支持）</p>"
},
{
"group": "Parameter",
"type": "String|false",
"optional": true,
"field": "complete_at",
"description": "<p>完成时间（如：2020-01-01 00:00，false表示未完成）</p>"
}
]
}
},
"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": "<p>任务ID</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "filename",
"description": "<p>post-文件名称</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "image64",
"description": "<p>post-base64图片（二选一）</p>"
},
{
"group": "Parameter",
"type": "File",
"optional": true,
"field": "files",
"description": "<p>post-文件对象（二选一）</p>"
}
]
}
},
"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": "<p>任务ID</p>"
}
]
}
},
"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": "<p>任务ID</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "type",
"description": "<p>类型</p> <ul> <li>add：归档（默认）</li> <li>recovery：还原归档</li> </ul>"
}
]
}
},
"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": "<p>任务ID</p>"
}
]
}
},
"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": "<p>项目ID</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": false,
"field": "task_id",
"description": "<p>任务ID（与 项目ID 二选一，任务ID优先）</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "page",
"description": "<p>当前页，默认:1</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "pagesize",
"description": "<p>每页显示数量，默认:20，最大:100</p>"
}
]
}
},
"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": "<p>搜索条件</p> <ul> <li>keys.email 邮箱</li> <li>keys.nickname 昵称</li> <li>keys.profession 职位</li> </ul>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "page",
"description": "<p>当前页，默认:1</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "pagesize",
"description": "<p>每页显示数量，默认:20，最大:50</p>"
}
]
}
},
"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": "<p>会员ID</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "type",
"description": "<p>操作</p> <ul> <li>setadmin 设为管理员</li> <li>clearadmin 取消管理员</li> <li>setdisable 设为禁用</li> <li>cleardisable 取消禁用</li> <li>delete 删除会员</li> </ul>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "password",
"description": "<p>新的密码</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "nickname",
"description": "<p>昵称</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "profession",
"description": "<p>职位</p>"
}
]
}
},
"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": "<p>需要token身份</p>",
"version": "1.0.0",
"group": "system",
"name": "fileupload",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "image64",
"description": "<p>图片base64</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "filename",
"description": "<p>文件名</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "files",
"description": "<p>文件名</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "ret",
"description": "<p>返回状态码（1正确、0错误）</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "msg",
"description": "<p>返回信息（错误描述）</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "data",
"description": "<p>返回数据</p>"
}
]
}
},
"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": "<p>文件名称</p>"
}
]
}
},
"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": "<p>返回状态码（1正确、0错误）</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "msg",
"description": "<p>返回信息（错误描述）</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "data",
"description": "<p>返回数据</p>"
}
]
}
},
"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": "<p>IP值</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "ret",
"description": "<p>返回状态码（1正确、0错误）</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "msg",
"description": "<p>返回信息（错误描述）</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "data",
"description": "<p>返回数据</p>"
}
]
}
},
"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": "<p>key值</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "ret",
"description": "<p>返回状态码（1正确、0错误）</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "msg",
"description": "<p>返回信息（错误描述）</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "data",
"description": "<p>返回数据</p>"
}
]
}
},
"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": "<p>返回状态码（1正确、0错误）</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "msg",
"description": "<p>返回信息（错误描述）</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "data",
"description": "<p>返回数据</p>"
}
]
}
},
"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": "<p>IP值</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "ret",
"description": "<p>返回状态码（1正确、0错误）</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "msg",
"description": "<p>返回信息（错误描述）</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "data",
"description": "<p>返回数据</p>"
}
]
}
},
"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": "<p>IP值</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "ret",
"description": "<p>返回状态码（1正确、0错误）</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "msg",
"description": "<p>返回信息（错误描述）</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "data",
"description": "<p>返回数据</p>"
}
]
}
},
"filename": "app/Http/Controllers/Api/SystemController.php",
"groupTitle": "系统"
},
{
"type": "post",
"url": "api/system/imgupload",
"title": "10. 上传图片",
"description": "<p>需要token身份</p>",
"version": "1.0.0",
"group": "system",
"name": "imgupload",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "image64",
"description": "<p>图片base64</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "filename",
"description": "<p>文件名</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "ret",
"description": "<p>返回状态码（1正确、0错误）</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "msg",
"description": "<p>返回信息（错误描述）</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "data",
"description": "<p>返回数据</p>"
}
]
}
},
"filename": "app/Http/Controllers/Api/SystemController.php",
"groupTitle": "系统"
},
{
"type": "get",
"url": "api/system/get/imgview",
"title": "11. 浏览图片空间",
"description": "<p>需要token身份</p>",
"version": "1.0.0",
"group": "system",
"name": "imgview",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "path",
"description": "<p>路径</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "ret",
"description": "<p>返回状态码（1正确、0错误）</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "msg",
"description": "<p>返回信息（错误描述）</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "data",
"description": "<p>返回数据</p>"
}
]
}
},
"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": "<p>优先级数据，格式：[{name,color,days,priority}]</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "ret",
"description": "<p>返回状态码（1正确、0错误）</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "msg",
"description": "<p>返回信息（错误描述）</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "data",
"description": "<p>返回数据</p>"
}
]
}
},
"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": "<ul> <li>get: 获取（默认）</li> <li>save: 保存设置（参数：reg、login_code）</li> </ul>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "ret",
"description": "<p>返回状态码（1正确、0错误）</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "msg",
"description": "<p>返回信息（错误描述）</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "data",
"description": "<p>返回数据</p>"
}
]
}
},
"filename": "app/Http/Controllers/Api/SystemController.php",
"groupTitle": "系统"
},
{
"type": "get",
"url": "api/users/basic",
"title": "09. 获取指定会员基础信息",
"description": "<p>需要token身份</p>",
"version": "1.0.0",
"group": "users",
"name": "basic",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "Number",
"optional": false,
"field": "userid",
"description": "<p>会员ID(多个格式：jsonArray，一次最多30个)</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "ret",
"description": "<p>返回状态码（1正确、0错误）</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "msg",
"description": "<p>返回信息（错误描述）</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "data",
"description": "<p>返回数据</p>"
}
]
}
},
"filename": "app/Http/Controllers/Api/UsersController.php",
"groupTitle": "会员"
},
{
"type": "get",
"url": "api/users/editdata",
"title": "06. 修改自己的资料",
"description": "<p>需要token身份</p>",
"version": "1.0.0",
"group": "users",
"name": "editdata",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "Object",
"optional": true,
"field": "userimg",
"description": "<p>会员头像（地址）</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "nickname",
"description": "<p>昵称</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "profession",
"description": "<p>职位/职称</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "ret",
"description": "<p>返回状态码（1正确、0错误）</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "msg",
"description": "<p>返回信息（错误描述）</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "data",
"description": "<p>返回数据（同&quot;获取我的信息&quot;接口）</p>"
}
]
}
},
"filename": "app/Http/Controllers/Api/UsersController.php",
"groupTitle": "会员"
},
{
"type": "get",
"url": "api/users/editpass",
"title": "07. 修改自己的密码",
"description": "<p>需要token身份</p>",
"version": "1.0.0",
"group": "users",
"name": "editpass",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "oldpass",
"description": "<p>旧密码</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "newpass",
"description": "<p>新密码</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "ret",
"description": "<p>返回状态码（1正确、0错误）</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "msg",
"description": "<p>返回信息（错误描述）</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "data",
"description": "<p>返回数据（同&quot;获取我的信息&quot;接口）</p>"
}
]
}
},
"filename": "app/Http/Controllers/Api/UsersController.php",
"groupTitle": "会员"
},
{
"type": "get",
"url": "api/users/info",
"title": "05. 获取我的信息",
"description": "<p>需要token身份</p>",
"version": "1.0.0",
"group": "users",
"name": "info",
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "ret",
"description": "<p>返回状态码（1正确、0错误）</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "msg",
"description": "<p>返回信息（错误描述）</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "data",
"description": "<p>返回数据</p>"
}
]
},
"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": "<p>需要token身份</p>",
"version": "1.0.0",
"group": "users",
"name": "login",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "type",
"description": "<p>类型</p> <ul> <li>login:登录（默认）</li> <li>reg:注册</li> </ul>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "email",
"description": "<p>邮箱</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "password",
"description": "<p>密码</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "code",
"description": "<p>登录验证码</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "key",
"description": "<p>登陆验证码key</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "ret",
"description": "<p>返回状态码（1正确、0错误）</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "msg",
"description": "<p>返回信息（错误描述）</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "data",
"description": "<p>返回数据（同&quot;获取我的信息&quot;接口）</p>"
}
]
}
},
"filename": "app/Http/Controllers/Api/UsersController.php",
"groupTitle": "会员"
},
{
"type": "get",
"url": "api/users/login/codeimg",
"title": "03. 验证码图片",
"description": "<p>用于判断是否需要登录验证码</p>",
"version": "1.0.0",
"group": "users",
"name": "login__codeimg",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "email",
"description": "<p>用户名</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Image",
"optional": false,
"field": "data",
"description": "<p>返回数据（直接输出图片）</p>"
}
]
}
},
"filename": "app/Http/Controllers/Api/UsersController.php",
"groupTitle": "会员"
},
{
"type": "get",
"url": "api/users/login/codejson",
"title": "04. 验证码json",
"description": "<p>用于判断是否需要登录验证码</p>",
"version": "1.0.0",
"group": "users",
"name": "login__codejson",
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "ret",
"description": "<p>返回状态码（1正确、0错误）</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "msg",
"description": "<p>返回信息（错误描述）</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "data",
"description": "<p>返回数据</p>"
}
]
}
},
"filename": "app/Http/Controllers/Api/UsersController.php",
"groupTitle": "会员"
},
{
"type": "get",
"url": "api/users/login/needcode",
"title": "02. 是否需要验证码",
"description": "<p>用于判断是否需要登录验证码</p>",
"version": "1.0.0",
"group": "users",
"name": "login__needcode",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "email",
"description": "<p>用户名</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "ret",
"description": "<p>返回状态码（1需要、0不需要）</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "msg",
"description": "<p>返回信息（错误描述）</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "data",
"description": "<p>返回数据</p>"
}
]
}
},
"filename": "app/Http/Controllers/Api/UsersController.php",
"groupTitle": "会员"
},
{
"type": "get",
"url": "api/users/search",
"title": "08. 搜索会员列表",
"description": "<p>搜索会员列表</p>",
"version": "1.0.0",
"group": "users",
"name": "searchinfo",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "Object",
"optional": false,
"field": "keys",
"description": "<p>搜索条件</p> <ul> <li>keys.key 昵称、邮箱</li> <li>keys.project_id 在指定项目ID</li> <li>keys.no_project_id 不在指定项目ID</li> </ul>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "take",
"description": "<p>获取数量，10-100</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "ret",
"description": "<p>返回状态码（1正确、0错误）</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "msg",
"description": "<p>返回信息（错误描述）</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "data",
"description": "<p>返回数据</p>"
}
]
}
},
"filename": "app/Http/Controllers/Api/UsersController.php",
"groupTitle": "会员"
}
]
Reference in New Issue View Git Blame Copy Permalink