优化注释

This commit is contained in:
kuaifan 2022-01-06 19:20:27 +08:00
parent f919a34166
commit 83e5c7fadb
7 changed files with 378 additions and 94 deletions

View File

@ -20,10 +20,19 @@ use Request;
class DialogController extends AbstractController
{
/**
* 对话列表
* @api {get} api/dialog/lists 01. 对话列表
*
* @apiDescription 需要token身份
* @apiVersion 1.0.0
* @apiGroup dialog
* @apiName lists
*
* @apiParam {Number} [page] 当前页,默认:1
* @apiParam {Number} [pagesize] 每页显示数量,默认:100,最大:200
*
* @apiSuccess {Number} ret 返回状态码1正确、0错误
* @apiSuccess {String} msg 返回信息(错误描述)
* @apiSuccess {Object} data 返回数据
*/
public function lists()
{
@ -42,9 +51,18 @@ class DialogController extends AbstractController
}
/**
* 获取单个会话信息
* @api {get} api/dialog/one 02. 获取单个会话信息
*
* @apiDescription 需要token身份
* @apiVersion 1.0.0
* @apiGroup dialog
* @apiName one
*
* @apiParam {Number} dialog_id 对话ID
*
* @apiSuccess {Number} ret 返回状态码1正确、0错误
* @apiSuccess {String} msg 返回信息(错误描述)
* @apiSuccess {Object} data 返回数据
*/
public function one()
{
@ -65,9 +83,18 @@ class DialogController extends AbstractController
}
/**
* 打开会话
* @api {get} api/dialog/msg/user 03. 打开会话
*
* @apiDescription 需要token身份
* @apiVersion 1.0.0
* @apiGroup dialog
* @apiName open__user
*
* @apiParam {Number} userid 对话会员ID
*
* @apiSuccess {Number} ret 返回状态码1正确、0错误
* @apiSuccess {String} msg 返回信息(错误描述)
* @apiSuccess {Object} data 返回数据
*/
public function open__user()
{
@ -90,12 +117,21 @@ class DialogController extends AbstractController
}
/**
* 获取消息列表
* @api {get} api/dialog/msg/lists 04. 获取消息列表
*
* @apiDescription 需要token身份
* @apiVersion 1.0.0
* @apiGroup dialog
* @apiName msg__lists
*
* @apiParam {Number} dialog_id 对话ID
*
* @apiParam {Number} [page] 当前页,默认:1
* @apiParam {Number} [pagesize] 每页显示数量,默认:50,最大:100
*
* @apiSuccess {Number} ret 返回状态码1正确、0错误
* @apiSuccess {String} msg 返回信息(错误描述)
* @apiSuccess {Object} data 返回数据
*/
public function msg__lists()
{
@ -124,7 +160,12 @@ class DialogController extends AbstractController
}
/**
* 未读消息
* @api {get} api/dialog/msg/sendtext 05. 未读消息
*
* @apiDescription 需要token身份
* @apiVersion 1.0.0
* @apiGroup dialog
* @apiName msg__sendtext
*/
public function msg__unread()
{
@ -135,10 +176,19 @@ class DialogController extends AbstractController
}
/**
* 发送消息
* @api {get} api/dialog/msg/sendtext 06. 发送消息
*
* @apiDescription 需要token身份
* @apiVersion 1.0.0
* @apiGroup dialog
* @apiName msg__sendtext
*
* @apiParam {Number} dialog_id 对话ID
* @apiParam {String} text 消息内容
*
* @apiSuccess {Number} ret 返回状态码1正确、0错误
* @apiSuccess {String} msg 返回信息(错误描述)
* @apiSuccess {Object} data 返回数据
*/
public function msg__sendtext()
{
@ -171,12 +221,21 @@ class DialogController extends AbstractController
}
/**
* {post}文件上传
* @api {post} api/dialog/msg/sendfile 07. 文件上传
*
* @apiDescription 需要token身份
* @apiVersion 1.0.0
* @apiGroup dialog
* @apiName msg__sendfile
*
* @apiParam {Number} dialog_id 对话ID
* @apiParam {String} [filename] post-文件名称
* @apiParam {String} [image64] post-base64图片二选一
* @apiParam {File} [files] post-文件对象(二选一)
*
* @apiSuccess {Number} ret 返回状态码1正确、0错误
* @apiSuccess {String} msg 返回信息(错误描述)
* @apiSuccess {Object} data 返回数据
*/
public function msg__sendfile()
{
@ -241,9 +300,18 @@ class DialogController extends AbstractController
}
/**
* 获取消息阅读情况
* @api {get} api/dialog/msg/readlist 08. 获取消息阅读情况
*
* @apiDescription 需要token身份
* @apiVersion 1.0.0
* @apiGroup dialog
* @apiName msg__readlist
*
* @apiParam {Number} msg_id 消息ID需要是消息的发送人
*
* @apiSuccess {Number} ret 返回状态码1正确、0错误
* @apiSuccess {String} msg 返回信息(错误描述)
* @apiSuccess {Object} data 返回数据
*/
public function msg__readlist()
{

View File

@ -22,9 +22,18 @@ use Request;
class FileController extends AbstractController
{
/**
* 获取文件列表
* @api {get} api/file/lists 01. 获取文件列表
*
* @apiDescription 需要token身份
* @apiVersion 1.0.0
* @apiGroup file
* @apiName lists
*
* @apiParam {Number} [pid] 父级ID
*
* @apiSuccess {Number} ret 返回状态码1正确、0错误
* @apiSuccess {String} msg 返回信息(错误描述)
* @apiSuccess {Object} data 返回数据
*/
public function lists()
{
@ -84,13 +93,20 @@ class FileController extends AbstractController
}
/**
* 获取单条数据
* @api {get} api/file/one 02. 获取单条数据
*
* @apiDescription 需要token身份
* @apiVersion 1.0.0
* @apiGroup file
* @apiName one
*
* @apiParam {Number|String} id
* - Number 文件ID需要登录
* - String 链接码(不需要登录,用于预览)
*
* @return array
* @apiSuccess {Number} ret 返回状态码1正确、0错误
* @apiSuccess {String} msg 返回信息(错误描述)
* @apiSuccess {Object} data 返回数据
*/
public function one()
{
@ -116,9 +132,18 @@ class FileController extends AbstractController
}
/**
* 搜索文件列表
* @api {get} api/file/search 03. 搜索文件列表
*
* @apiDescription 需要token身份
* @apiVersion 1.0.0
* @apiGroup file
* @apiName search
*
* @apiParam {String} [key] 关键词
*
* @apiSuccess {Number} ret 返回状态码1正确、0错误
* @apiSuccess {String} msg 返回信息(错误描述)
* @apiSuccess {Object} data 返回数据
*/
public function search()
{
@ -136,12 +161,21 @@ class FileController extends AbstractController
}
/**
* 添加、修改文件()
* @api {get} api/file/add 04. 添加、修改文件()
*
* @apiDescription 需要token身份
* @apiVersion 1.0.0
* @apiGroup file
* @apiName add
*
* @apiParam {String} name 项目名称
* @apiParam {String} type 文件类型
* @apiParam {Number} [id] 文件ID赋值修改文件名称
* @apiParam {Number} [pid] 父级ID
*
* @apiSuccess {Number} ret 返回状态码1正确、0错误
* @apiSuccess {String} msg 返回信息(错误描述)
* @apiSuccess {Object} data 返回数据
*/
public function add()
{
@ -218,9 +252,18 @@ class FileController extends AbstractController
}
/**
* 复制文件()
* @api {get} api/file/copy 05. 复制文件()
*
* @apiDescription 需要token身份
* @apiVersion 1.0.0
* @apiGroup file
* @apiName copy
*
* @apiParam {Number} id 文件ID
*
* @apiSuccess {Number} ret 返回状态码1正确、0错误
* @apiSuccess {String} msg 返回信息(错误描述)
* @apiSuccess {Object} data 返回数据
*/
public function copy()
{
@ -258,10 +301,19 @@ class FileController extends AbstractController
}
/**
* 移动文件()
* @api {get} api/file/move 06. 移动文件()
*
* @apiDescription 需要token身份
* @apiVersion 1.0.0
* @apiGroup file
* @apiName move
*
* @apiParam {Number} id 文件ID
* @apiParam {Number} pid 移动到的文件夹ID
*
* @apiSuccess {Number} ret 返回状态码1正确、0错误
* @apiSuccess {String} msg 返回信息(错误描述)
* @apiSuccess {Object} data 返回数据
*/
public function move()
{
@ -294,9 +346,18 @@ class FileController extends AbstractController
}
/**
* 删除文件()
* @api {get} api/file/remove 07. 删除文件()
*
* @apiDescription 需要token身份
* @apiVersion 1.0.0
* @apiGroup file
* @apiName remove
*
* @apiParam {Number} id 文件ID
*
* @apiSuccess {Number} ret 返回状态码1正确、0错误
* @apiSuccess {String} msg 返回信息(错误描述)
* @apiSuccess {Object} data 返回数据
*/
public function remove()
{
@ -311,11 +372,20 @@ class FileController extends AbstractController
}
/**
* 获取文件内容
* @api {get} api/file/content 08. 获取文件内容
*
* @apiDescription 需要token身份
* @apiVersion 1.0.0
* @apiGroup file
* @apiName content
*
* @apiParam {Number|String} id
* - Number 文件ID需要登录
* - String 链接码(不需要登录,用于预览)
*
* @apiSuccess {Number} ret 返回状态码1正确、0错误
* @apiSuccess {String} msg 返回信息(错误描述)
* @apiSuccess {Object} data 返回数据
*/
public function content()
{
@ -339,11 +409,20 @@ class FileController extends AbstractController
}
/**
* 保存文件内容
* @api {get} api/file/content/save 09. 保存文件内容
*
* @apiDescription 需要token身份
* @apiVersion 1.0.0
* @apiGroup file
* @apiName content__save
*
* @apiParam {Number} id 文件ID
* @apiParam {Object} [D] Request Payload 提交
* - content: 内容
*
* @apiSuccess {Number} ret 返回状态码1正确、0错误
* @apiSuccess {String} msg 返回信息(错误描述)
* @apiSuccess {Object} data 返回数据
*/
public function content__save()
{
@ -392,9 +471,18 @@ class FileController extends AbstractController
}
/**
* 保存文件内容office
* @api {get} api/file/content/office 10. 保存文件内容office
*
* @apiDescription 需要token身份
* @apiVersion 1.0.0
* @apiGroup file
* @apiName content__office
*
* @apiParam {Number} id 文件ID
*
* @apiSuccess {Number} ret 返回状态码1正确、0错误
* @apiSuccess {String} msg 返回信息(错误描述)
* @apiSuccess {Object} data 返回数据
*/
public function content__office()
{
@ -436,10 +524,19 @@ class FileController extends AbstractController
}
/**
* 保存文件内容(上传文件)
* @api {get} api/file/content/upload 11. 保存文件内容(上传文件)
*
* @apiDescription 需要token身份
* @apiVersion 1.0.0
* @apiGroup file
* @apiName content__upload
*
* @apiParam {Number} [pid] 父级ID
* @apiParam {String} [files] 文件名
*
* @apiSuccess {Number} ret 返回状态码1正确、0错误
* @apiSuccess {String} msg 返回信息(错误描述)
* @apiSuccess {Object} data 返回数据
*/
public function content__upload()
{
@ -526,9 +623,18 @@ class FileController extends AbstractController
}
/**
* 获取共享信息
* @api {get} api/file/share 12. 获取共享信息
*
* @apiDescription 需要token身份
* @apiVersion 1.0.0
* @apiGroup file
* @apiName share
*
* @apiParam {Number} id 文件ID
*
* @apiSuccess {Number} ret 返回状态码1正确、0错误
* @apiSuccess {String} msg 返回信息(错误描述)
* @apiSuccess {Object} data 返回数据
*/
public function share()
{
@ -553,7 +659,12 @@ class FileController extends AbstractController
}
/**
* 设置共享
* @api {get} api/file/share/update 13. 设置共享
*
* @apiDescription 需要token身份
* @apiVersion 1.0.0
* @apiGroup file
* @apiName share__update
*
* @apiParam {Number} id 文件ID
* @apiParam {Array} [userids] 共享成员,格式: [userid1, userid2, userid3]
@ -561,6 +672,10 @@ class FileController extends AbstractController
* - 0:只读
* - 1:读写
* - -1: 删除
*
* @apiSuccess {Number} ret 返回状态码1正确、0错误
* @apiSuccess {String} msg 返回信息(错误描述)
* @apiSuccess {Object} data 返回数据
*/
public function share__update()
{
@ -626,9 +741,18 @@ class FileController extends AbstractController
}
/**
* 退出共享
* @api {get} api/file/share/out 14. 退出共享
*
* @apiDescription 需要token身份
* @apiVersion 1.0.0
* @apiGroup file
* @apiName share__out
*
* @apiParam {Number} id 文件ID
*
* @apiSuccess {Number} ret 返回状态码1正确、0错误
* @apiSuccess {String} msg 返回信息(错误描述)
* @apiSuccess {Object} data 返回数据
*/
public function share__out()
{
@ -657,12 +781,21 @@ class FileController extends AbstractController
}
/**
* 获取链接
* @api {get} api/file/link 15. 获取链接
*
* @apiDescription 需要token身份
* @apiVersion 1.0.0
* @apiGroup file
* @apiName link
*
* @apiParam {Number} id 文件ID
* @apiParam {String} refresh 刷新链接
* - no: 只获取(默认)
* - yes: 刷新链接,之前的将失效
*
* @apiSuccess {Number} ret 返回状态码1正确、0错误
* @apiSuccess {String} msg 返回信息(错误描述)
* @apiSuccess {Object} data 返回数据
*/
public function link()
{

View File

@ -26,7 +26,7 @@ use Request;
class ProjectController extends AbstractController
{
/**
* @api {get} api/project/lists 获取项目列表
* @api {get} api/project/lists 01. 获取项目列表
*
* @apiDescription 需要token身份
* @apiVersion 1.0.0
@ -130,7 +130,7 @@ class ProjectController extends AbstractController
}
/**
* @api {get} api/project/one 获取一个项目信息
* @api {get} api/project/one 02. 获取一个项目信息
*
* @apiDescription 需要token身份
* @apiVersion 1.0.0
@ -191,7 +191,7 @@ class ProjectController extends AbstractController
}
/**
* @api {get} api/project/add 添加项目
* @api {get} api/project/add 03. 添加项目
*
* @apiDescription 需要token身份
* @apiVersion 1.0.0
@ -274,7 +274,7 @@ class ProjectController extends AbstractController
}
/**
* @api {get} api/project/update 修改项目
* @api {get} api/project/update 04. 修改项目
*
* @apiDescription 需要token身份项目负责人
* @apiVersion 1.0.0
@ -322,7 +322,7 @@ class ProjectController extends AbstractController
}
/**
* @api {get} api/project/user 修改项目成员
* @api {get} api/project/user 05. 修改项目成员
*
* @apiDescription 需要token身份项目负责人
* @apiVersion 1.0.0
@ -373,7 +373,7 @@ class ProjectController extends AbstractController
}
/**
* @api {get} api/project/invite 获取邀请链接
* @api {get} api/project/invite 06. 获取邀请链接
*
* @apiDescription 需要token身份项目负责人
* @apiVersion 1.0.0
@ -423,7 +423,7 @@ class ProjectController extends AbstractController
}
/**
* @api {get} api/project/invite/info 通过邀请链接code获取项目信息
* @api {get} api/project/invite/info 07. 通过邀请链接code获取项目信息
*
* @apiDescription 需要token身份
* @apiVersion 1.0.0
@ -455,7 +455,7 @@ class ProjectController extends AbstractController
}
/**
* @api {get} api/project/invite/join 通过邀请链接code加入项目
* @api {get} api/project/invite/join 08. 通过邀请链接code加入项目
*
* @apiDescription 需要token身份
* @apiVersion 1.0.0
@ -501,7 +501,7 @@ class ProjectController extends AbstractController
}
/**
* @api {get} api/project/transfer 移交项目
* @api {get} api/project/transfer 09. 移交项目
*
* @apiDescription 需要token身份项目负责人
* @apiVersion 1.0.0
@ -545,7 +545,7 @@ class ProjectController extends AbstractController
}
/**
* @api {get} api/project/sort 排序任务
* @api {get} api/project/sort 10. 排序任务
*
* @apiDescription 需要token身份
* @apiVersion 1.0.0
@ -607,7 +607,7 @@ class ProjectController extends AbstractController
}
/**
* @api {get} api/project/exit 退出项目
* @api {get} api/project/exit 11. 退出项目
*
* @apiDescription 需要token身份
* @apiVersion 1.0.0
@ -639,7 +639,7 @@ class ProjectController extends AbstractController
}
/**
* @api {get} api/project/archived 归档项目
* @api {get} api/project/archived 12. 归档项目
*
* @apiDescription 需要token身份项目负责人
* @apiVersion 1.0.0
@ -673,7 +673,7 @@ class ProjectController extends AbstractController
}
/**
* @api {get} api/project/remove 删除项目
* @api {get} api/project/remove 13. 删除项目
*
* @apiDescription 需要token身份项目负责人
* @apiVersion 1.0.0
@ -699,7 +699,7 @@ class ProjectController extends AbstractController
}
/**
* @api {get} api/project/column/lists 获取任务列表
* @api {get} api/project/column/lists 14. 获取任务列表
*
* @apiDescription 需要token身份
* @apiVersion 1.0.0
@ -732,7 +732,7 @@ class ProjectController extends AbstractController
}
/**
* @api {get} api/project/column/add 添加任务列表
* @api {get} api/project/column/add 15. 添加任务列表
*
* @apiDescription 需要token身份
* @apiVersion 1.0.0
@ -777,7 +777,7 @@ class ProjectController extends AbstractController
}
/**
* @api {get} api/project/column/update 修改任务列表
* @api {get} api/project/column/update 16. 修改任务列表
*
* @apiDescription 需要token身份
* @apiVersion 1.0.0
@ -820,7 +820,7 @@ class ProjectController extends AbstractController
}
/**
* @api {get} api/project/column/remove 删除任务列表
* @api {get} api/project/column/remove 17. 删除任务列表
*
* @apiDescription 需要token身份
* @apiVersion 1.0.0
@ -851,7 +851,7 @@ class ProjectController extends AbstractController
}
/**
* @api {get} api/project/task/lists 任务列表
* @api {get} api/project/task/lists 18. 任务列表
*
* @apiDescription 需要token身份
* @apiVersion 1.0.0
@ -962,7 +962,7 @@ class ProjectController extends AbstractController
}
/**
* @api {get} api/project/task/one 获取单个任务信息
* @api {get} api/project/task/one 19. 获取单个任务信息
*
* @apiDescription 需要token身份
* @apiVersion 1.0.0
@ -990,7 +990,7 @@ class ProjectController extends AbstractController
}
/**
* @api {get} api/project/task/content 获取任务详细描述
* @api {get} api/project/task/content 20. 获取任务详细描述
*
* @apiDescription 需要token身份
* @apiVersion 1.0.0
@ -1015,7 +1015,7 @@ class ProjectController extends AbstractController
}
/**
* @api {get} api/project/task/files 获取任务文件列表
* @api {get} api/project/task/files 21. 获取任务文件列表
*
* @apiDescription 需要token身份
* @apiVersion 1.0.0
@ -1040,7 +1040,7 @@ class ProjectController extends AbstractController
}
/**
* @api {get} api/project/task/filedelete 删除任务文件
* @api {get} api/project/task/filedelete 22. 删除任务文件
*
* @apiDescription 需要token身份项目、任务负责人
* @apiVersion 1.0.0
@ -1073,7 +1073,7 @@ class ProjectController extends AbstractController
}
/**
* @api {post} api/project/task/add 添加任务
* @api {post} api/project/task/add 23. 添加任务
*
* @apiDescription 需要token身份
* @apiVersion 1.0.0
@ -1143,7 +1143,7 @@ class ProjectController extends AbstractController
}
/**
* @api {get} api/project/task/addsub 添加子任务
* @api {get} api/project/task/addsub 24. 添加子任务
*
* @apiDescription 需要token身份项目、任务负责人
* @apiVersion 1.0.0
@ -1183,7 +1183,7 @@ class ProjectController extends AbstractController
}
/**
* @api {post} api/project/task/update 修改任务、子任务
* @api {post} api/project/task/update 25. 修改任务、子任务
*
* @apiDescription 需要token身份项目、任务负责人
* @apiVersion 1.0.0
@ -1232,7 +1232,7 @@ class ProjectController extends AbstractController
}
/**
* @api {post} api/project/task/upload 上传文件
* @api {post} api/project/task/upload 26. 上传文件
*
* @apiDescription 需要token身份项目、任务负责人
* @apiVersion 1.0.0
@ -1298,7 +1298,7 @@ class ProjectController extends AbstractController
}
/**
* @api {get} api/project/task/dialog 创建/获取聊天室
* @api {get} api/project/task/dialog 27. 创建/获取聊天室
*
* @apiDescription 需要token身份
* @apiVersion 1.0.0
@ -1345,7 +1345,7 @@ class ProjectController extends AbstractController
}
/**
* @api {get} api/project/task/archived 归档任务
* @api {get} api/project/task/archived 28. 归档任务
*
* @apiDescription 需要token身份项目、任务负责人
* @apiVersion 1.0.0
@ -1383,7 +1383,7 @@ class ProjectController extends AbstractController
}
/**
* @api {get} api/project/task/remove 删除任务
* @api {get} api/project/task/remove 29. 删除任务
*
* @apiDescription 需要token身份项目、任务负责人
* @apiVersion 1.0.0
@ -1409,7 +1409,7 @@ class ProjectController extends AbstractController
}
/**
* @api {get} api/project/log/lists 获取项目、任务日志
* @api {get} api/project/log/lists 30. 获取项目、任务日志
*
* @apiDescription 需要token身份
* @apiVersion 1.0.0

View File

@ -408,7 +408,12 @@ class UsersController extends AbstractController
}
/**
* 会员列表(限管理员)
* @api {get} api/users/lists 11. 会员列表(限管理员)
*
* @apiDescription 需要token身份
* @apiVersion 1.0.0
* @apiGroup users
* @apiName lists
*
* @apiParam {Object} [keys] 搜索条件
* - keys.email 邮箱
@ -416,6 +421,10 @@ class UsersController extends AbstractController
* - keys.profession 职位
* @apiParam {Number} [page] 当前页,默认:1
* @apiParam {Number} [pagesize] 每页显示数量,默认:20,最大:50
*
* @apiSuccess {Number} ret 返回状态码1正确、0错误
* @apiSuccess {String} msg 返回信息(错误描述)
* @apiSuccess {Object} data 返回数据
*/
public function lists()
{
@ -448,7 +457,12 @@ class UsersController extends AbstractController
}
/**
* 操作会员(限管理员)
* @api {get} api/users/operation 12. 操作会员(限管理员)
*
* @apiDescription 需要token身份
* @apiVersion 1.0.0
* @apiGroup users
* @apiName operation
*
* @apiParam {Number} userid 会员ID
* @apiParam {String} [type] 操作
@ -460,6 +474,10 @@ class UsersController extends AbstractController
* @apiParam {String} [password] 新的密码
* @apiParam {String} [nickname] 昵称
* @apiParam {String} [profession] 职位
*
* @apiSuccess {Number} ret 返回状态码1正确、0错误
* @apiSuccess {String} msg 返回信息(错误描述)
* @apiSuccess {Object} data 返回数据
*/
public function operation()
{

View File

@ -4,7 +4,7 @@
* 给apidoc项目增加顺序编号
*/
error_reporting(E_ALL & ~E_NOTICE);
@error_reporting(E_ALL & ~E_NOTICE & ~E_WARNING);
$path = dirname(__FILE__). '/';
$lists = scandir($path);

File diff suppressed because one or more lines are too long

View File

@ -211,7 +211,9 @@
{{#if optional}}
<span class="label optional">{{__ "optional"}}</span>
{{else}}
<span class="label required">{{__ "required"}}</span>
{{#if ../template.showRequiredLabels}}
<span class="label required">{{__ "required"}}</span>
{{/if}}
{{/if}}
</td>
{{#unless this.Type compare=null}}
@ -254,7 +256,9 @@
{{#if optional}}
<span class="label optional">{{__ "optional"}}</span>
{{else}}
<span class="label required">{{__ "required"}}</span>
{{#if ../template.showRequiredLabels}}
<span class="label required">{{__ "required"}}</span>
{{/if}}
{{/if}}
</td>
{{#unless this.Type compare=null}}
@ -302,7 +306,9 @@
{{#if optional}}
<span class="label optional">{{__ "optional"}}</span>
{{else}}
<span class="label required">{{__ "required"}}</span>
{{#if ../template.showRequiredLabels}}
<span class="label required">{{__ "required"}}</span>
{{/if}}
{{/if}}</td>
{{#if ../../_hasType}}
<td class="code">