diff --git a/build/doc/api_zh.md b/build/doc/api_zh.md index 08217ab..32110e0 100644 --- a/build/doc/api_zh.md +++ b/build/doc/api_zh.md @@ -388,6 +388,7 @@ AlienController | `alien_controller.go` | 第三方授权上传,下载,预 **功能**:编辑网站偏好设置,修改网站名称,logo,版权,备案信息。 **访问级别**:`管理员` **请求参数**: + 名称 | 类型 | 必填性 | 描述 --------- | ---- | ---- | ----------- name | `string` | 必填 | 网站名称 @@ -411,6 +412,7 @@ footerLine2 | `string` | 选填 | 网站备案信息 **功能**:创建文件夹 **访问级别**:`注册用户`,`管理员` **请求参数**: + 名称 | 类型 | 必填性 | 描述 --------- | ---- | ---- | ----------- puuid | `string` | 必填 | 准备创建的目录所在的目录,如果在根目录下创建传`root` @@ -426,6 +428,7 @@ name | `string` | 必填 | 文件夹名称, 不能包含以下特殊符号:` **功能**:上传文件 **访问级别**:`注册用户`,`管理员` **请求参数**: + 名称 | 类型 | 必填性 | 描述 --------- | ---- | ---- | ----------- userUuid | `string` | 选填 | 该文件的归属人,如果不填则使用当前登录的用户uuid;如果是管理员要给用户A上传文件,那么这里应该填A的uuid. @@ -445,6 +448,7 @@ file | `file` | 必填 | 文件,在浏览器中是通过` \| **功能**:改变文件的公私有属性 **访问级别**:`注册用户`,`管理员` **请求参数**: + 名称 | 类型 | 必填性 | 描述 --------- | ---- | ---- | ----------- uuid | `string` | 必填 | 文件的uuid @@ -500,6 +507,7 @@ privacy | `bool` | 选填 | 文件的私有性,默认`false` **功能**:将一个文件夹或者文件移入到另一个文件夹下。 **访问级别**:`注册用户`,`管理员` **请求参数**: + 名称 | 类型 | 必填性 | 描述 --------- | ---- | ---- | ----------- srcUuids | `string` | 必填 | 待移动的文件或文件夹的uuids,用逗号(,)分隔。 @@ -515,6 +523,7 @@ destUuid | `string` | 必填 | 目标文件夹,根目录用`root` **功能**:产看文件详情 **访问级别**:`注册用户`,`管理员` **请求参数**: + 名称 | 类型 | 必填性 | 描述 --------- | ---- | ---- | ----------- uuid | `string` | 必填 | 该文件的uuid。 @@ -529,6 +538,7 @@ destUuid | `string` | 必填 | 目标文件夹,根目录用`root` **功能**:按照分页的方式获取某个文件夹下文件和子文件夹的列表 **访问级别**:`注册用户`,`管理员` **请求参数**: + 名称 | 类型 | 必填性 | 描述 --------- | ---- | ---- | ----------- puuid | `string` | 选填 | 文件夹uuid,如果根目录填`root` @@ -555,6 +565,7 @@ extensions | `string` | 选填 | 按文件后缀名筛选,逗号(,)分隔。 **功能**:下载文件。 **访问级别**:`游客`,`注册用户`,`管理员` **请求参数**: 均是放置在url中 + 名称 | 类型 | 必填性 | 描述 --------- | ---- | ---- | ----------- uuid | `string` | 必填 | 要下载的文件uuid @@ -575,6 +586,7 @@ filename | `string` | 必填 | 要下载的文件名 **功能**:创建用户 **访问级别**:`管理员` **请求参数**: + 名称 | 类型 | 必填性 | 描述 --------- | ---- | ---- | ----------- username | `string` | 必填 | 用户名,且只能包含字母,数字和'_' @@ -597,6 +609,7 @@ sizeLimit | `string` | 选填 | 用户上传单文件限制,单位byte. 如果 **功能**:编辑用户 **访问级别**:`注册用户`,`管理员` **请求参数**: + 名称 | 类型 | 必填性 | 描述 --------- | ---- | ---- | ----------- uuid | `string` | 必填 | 待编辑的用户uuid @@ -617,6 +630,7 @@ sizeLimit | `string` | 选填 | 用户上传单文件限制,单位byte. 如果 **功能**:用户修改密码 **访问级别**:`注册用户`,`管理员` **请求参数**: + 名称 | 类型 | 必填性 | 描述 --------- | ---- | ---- | ----------- oldPassword | `string` | 必填 | 旧密码 @@ -632,6 +646,7 @@ newPassword | `string` | 必填 | 新密码 **功能**:管理员重置用户密码 **访问级别**:`管理员` **请求参数**: + 名称 | 类型 | 必填性 | 描述 --------- | ---- | ---- | ----------- userUuid | `string` | 必填 | 待重置密码的用户uuid @@ -646,6 +661,7 @@ password | `string` | 必填 | 密码 **功能**:登录 **访问级别**:`游客`,`注册用户`,`管理员` **请求参数**: + 名称 | 类型 | 必填性 | 描述 --------- | ---- | ---- | ----------- email | `string` | 必填 | 邮箱 @@ -670,6 +686,7 @@ password | `string` | 必填 | 密码 **功能**:查看用户详情 **访问级别**:`游客`,`注册用户`,`管理员` **请求参数**: + 名称 | 类型 | 必填性 | 描述 --------- | ---- | ---- | ----------- uuid | `string` | 必填 | 待查看的用户uuid @@ -683,6 +700,7 @@ uuid | `string` | 必填 | 待查看的用户uuid **功能**:查看用户列表 **访问级别**:`管理员` **请求参数**: + 名称 | 类型 | 必填性 | 描述 --------- | ---- | ---- | ----------- page | `int` | 选填 | 当前页数,0基,默认0 @@ -702,6 +720,7 @@ orderCreateTime | `DESC`或`ASC` | 选填 | 按创建时间排序,`DESC`降序 **功能**:禁用用户 **访问级别**:`管理员` **请求参数**: + 名称 | 类型 | 必填性 | 描述 --------- | ---- | ---- | ----------- uuid | `string` | 必填 | 待操作的用户