sharing

POST 列出全部分享

POST 列出全部分享

POST /api/share/list

Body 请求参数

json
{
  "page": 1,
  "per_page": 0
}

POST /api/share/list

Body 请求参数

json
{
  "page": 1,
  "per_page": 0
}

请求参数

请求参数

名称位置类型必选中文名说明
Authorizationheaderstringtoken
Content-Typeheaderstringnone
bodybodyobjectnone
» pagebodyinteger页数none
» per_pagebodyinteger每页数目none
名称位置类型必选中文名说明
Authorizationheaderstringtoken
Content-Typeheaderstringnone
bodybodyobjectnone
» pagebodyinteger页数none
» per_pagebodyinteger每页数目none

返回示例

返回示例

成功

json
{
  "code": 200,
  "message": "success",
  "data": {
    "content": [
      {
        "id": "j20jfpiY",
        "expires": "2024-12-30T18:32:12.4250369+08:00",
        "pwd": "z8YB0",
        "accessed": 2,
        "max_accessed": 0,
        "disabled": false,
        "remark": "",
        "readme": "",
        "header": "",
        "order_by": "name",
        "order_direction": "asc",
        "extract_folder": "front",
        "files": ["/tt/test.rar"],
        "creator": "admin",
        "creator_role": 2
      }
    ],
    "total": 1
  }
}

成功

json
{
  "code": 200,
  "message": "success",
  "data": {
    "content": [
      {
        "id": "j20jfpiY",
        "expires": "2024-12-30T18:32:12.4250369+08:00",
        "pwd": "z8YB0",
        "accessed": 2,
        "max_accessed": 0,
        "disabled": false,
        "remark": "",
        "readme": "",
        "header": "",
        "order_by": "name",
        "order_direction": "asc",
        "extract_folder": "front",
        "files": ["/tt/test.rar"],
        "creator": "admin",
        "creator_role": 2
      }
    ],
    "total": 1
  }
}

返回结果

返回结果

状态码状态码含义说明数据模型
200OK成功Inline
状态码状态码含义说明数据模型
200OK成功Inline

返回数据结构

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenone状态码none
» messagestringtruenone信息none
» dataobjecttruenonenone
»» content[object]truenone对于非管理员,只包含creator为自身的分享
»»» idstringtruenone分享 IDnone
»»» expiresstringtruenone过期时间未设置时为""
»»» pwdstringtruenone分享码未设置时为""
»»» accessedintegertruenone访问数none
»»» max_accessedintegertruenone最大访问数未设置时为0
»»» disabledbooleantruenone是否被禁用none
»»» remarkstringtruenone备注none
»»» readmestringtruenone说明none
»»» headerstringtruenone头部说明none
»»» order_bystringtruenone排序方式有效值有"name", "size", "modified", ""
»»» order_directionstringtruenone排序方向有效值有"asc", "desc", ""
»»» extract_folderstringtruenone提取文件夹有效值有"front", "back", ""
»»» files[string]truenone被分享文件路径none
»»» creatorstringtruenone分享创建者用户名none
»»» creator_roleintegertruenone分享创建者角色0: 普通用户,1: 访客,2: 管理员
»» totalintegertruenone总数none

状态码 200

名称类型必选约束中文名说明
» codeintegertruenone状态码none
» messagestringtruenone信息none
» dataobjecttruenonenone
»» content[object]truenone对于非管理员,只包含creator为自身的分享
»»» idstringtruenone分享 IDnone
»»» expiresstringtruenone过期时间未设置时为""
»»» pwdstringtruenone分享码未设置时为""
»»» accessedintegertruenone访问数none
»»» max_accessedintegertruenone最大访问数未设置时为0
»»» disabledbooleantruenone是否被禁用none
»»» remarkstringtruenone备注none
»»» readmestringtruenone说明none
»»» headerstringtruenone头部说明none
»»» order_bystringtruenone排序方式有效值有"name", "size", "modified", ""
»»» order_directionstringtruenone排序方向有效值有"asc", "desc", ""
»»» extract_folderstringtruenone提取文件夹有效值有"front", "back", ""
»»» files[string]truenone被分享文件路径none
»»» creatorstringtruenone分享创建者用户名none
»»» creator_roleintegertruenone分享创建者角色0: 普通用户,1: 访客,2: 管理员
»» totalintegertruenone总数none

GET 获取分享信息

GET 获取分享信息

GET /api/share/get

GET /api/share/get

请求参数

请求参数

名称位置类型必选中文名说明
idquerystring分享 IDnone
Authorizationheaderstringtoken
名称位置类型必选中文名说明
idquerystring分享 IDnone
Authorizationheaderstringtoken

返回示例

返回示例

成功

json
{
  "code": 200,
  "message": "success",
  "data": {
    "id": "j20jfpiY",
    "expires": "2024-12-30T18:32:12.4250369+08:00",
    "pwd": "z8YB0",
    "accessed": 2,
    "max_accessed": 0,
    "disabled": false,
    "remark": "",
    "readme": "",
    "header": "",
    "order_by": "name",
    "order_direction": "asc",
    "extract_folder": "front",
    "files": ["/tt/test.rar"],
    "creator": "admin",
    "creator_role": 2
  }
}

成功

json
{
  "code": 200,
  "message": "success",
  "data": {
    "id": "j20jfpiY",
    "expires": "2024-12-30T18:32:12.4250369+08:00",
    "pwd": "z8YB0",
    "accessed": 2,
    "max_accessed": 0,
    "disabled": false,
    "remark": "",
    "readme": "",
    "header": "",
    "order_by": "name",
    "order_direction": "asc",
    "extract_folder": "front",
    "files": ["/tt/test.rar"],
    "creator": "admin",
    "creator_role": 2
  }
}

返回结果

返回结果

状态码状态码含义说明数据模型
200OK成功Inline
状态码状态码含义说明数据模型
200OK成功Inline

返回数据结构

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenone状态码none
» messagestringtruenone信息none
» dataobjecttruenonenone
»» idstringtruenone分享 IDnone
»» expiresstringtruenone过期时间未设置时为""
»» pwdstringtruenone分享码未设置时为""
»» accessedintegertruenone访问数none
»» max_accessedintegertruenone最大访问数未设置时为0
»» disabledbooleantruenone是否被禁用none
»» remarkstringtruenone备注none
»» readmestringtruenone说明none
»» headerstringtruenone头部说明none
»» order_bystringtruenone排序方式有效值有"name", "size", "modified", ""
»» order_directionstringtruenone排序方向有效值有"asc", "desc", ""
»» extract_folderstringtruenone提取文件夹有效值有"front", "back", ""
»» files[string]truenone分享路径none
»» creatorstringtruenone分享创建者用户名none
»» creator_roleintegertruenone分享创建者角色0: 普通用户,1: 访客,2: 管理员

状态码 200

名称类型必选约束中文名说明
» codeintegertruenone状态码none
» messagestringtruenone信息none
» dataobjecttruenonenone
»» idstringtruenone分享 IDnone
»» expiresstringtruenone过期时间未设置时为""
»» pwdstringtruenone分享码未设置时为""
»» accessedintegertruenone访问数none
»» max_accessedintegertruenone最大访问数未设置时为0
»» disabledbooleantruenone是否被禁用none
»» remarkstringtruenone备注none
»» readmestringtruenone说明none
»» headerstringtruenone头部说明none
»» order_bystringtruenone排序方式有效值有"name", "size", "modified", ""
»» order_directionstringtruenone排序方向有效值有"asc", "desc", ""
»» extract_folderstringtruenone提取文件夹有效值有"front", "back", ""
»» files[string]truenone分享路径none
»» creatorstringtruenone分享创建者用户名none
»» creator_roleintegertruenone分享创建者角色0: 普通用户,1: 访客,2: 管理员

POST 新建分享

POST 新建分享

POST /api/share/create

Body 请求参数

json
{
  "expires": "2024-12-30T18:32:12.4250369+08:00",
  "pwd": "z8YB0",
  "max_accessed": 0,
  "disabled": false,
  "remark": "",
  "readme": "",
  "header": "",
  "order_by": "name",
  "order_direction": "asc",
  "extract_folder": "front",
  "files": ["/tt/test.rar"]
}

POST /api/share/create

Body 请求参数

json
{
  "expires": "2024-12-30T18:32:12.4250369+08:00",
  "pwd": "z8YB0",
  "max_accessed": 0,
  "disabled": false,
  "remark": "",
  "readme": "",
  "header": "",
  "order_by": "name",
  "order_direction": "asc",
  "extract_folder": "front",
  "files": ["/tt/test.rar"]
}

请求参数

请求参数

名称位置类型必选中文名说明
Authorizationheaderstringtoken
Content-Typeheaderstringnone
bodybodyobjectnone
» expiresstringtruenone过期时间不设置时为""
» pwdstringtruenone分享码不设置时为""
» max_accessedintegertruenone最大访问数不设置时为0
» disabledbooleantruenone是否被禁用none
» remarkstringtruenone备注none
» readmestringtruenone说明none
» headerstringtruenone头部说明none
» order_bystringtruenone排序方式有效值有"name", "size", "modified", ""
» order_directionstringtruenone排序方向有效值有"asc", "desc", ""
» extract_folderstringtruenone提取文件夹有效值有"front", "back", ""
» files[string]truenone被分享文件路径none
名称位置类型必选中文名说明
Authorizationheaderstringtoken
Content-Typeheaderstringnone
bodybodyobjectnone
» expiresstringtruenone过期时间不设置时为""
» pwdstringtruenone分享码不设置时为""
» max_accessedintegertruenone最大访问数不设置时为0
» disabledbooleantruenone是否被禁用none
» remarkstringtruenone备注none
» readmestringtruenone说明none
» headerstringtruenone头部说明none
» order_bystringtruenone排序方式有效值有"name", "size", "modified", ""
» order_directionstringtruenone排序方向有效值有"asc", "desc", ""
» extract_folderstringtruenone提取文件夹有效值有"front", "back", ""
» files[string]truenone被分享文件路径none

返回示例

返回示例

成功

json
{
  "code": 200,
  "message": "success",
  "data": {
    "id": "j20jfpiY",
    "expires": "2024-12-30T18:32:12.4250369+08:00",
    "pwd": "z8YB0",
    "accessed": 0,
    "max_accessed": 0,
    "disabled": false,
    "remark": "",
    "readme": "",
    "header": "",
    "order_by": "name",
    "order_direction": "asc",
    "extract_folder": "front",
    "files": ["/tt/test.rar"],
    "creator": "admin",
    "creator_role": 2
  }
}

成功

json
{
  "code": 200,
  "message": "success",
  "data": {
    "id": "j20jfpiY",
    "expires": "2024-12-30T18:32:12.4250369+08:00",
    "pwd": "z8YB0",
    "accessed": 0,
    "max_accessed": 0,
    "disabled": false,
    "remark": "",
    "readme": "",
    "header": "",
    "order_by": "name",
    "order_direction": "asc",
    "extract_folder": "front",
    "files": ["/tt/test.rar"],
    "creator": "admin",
    "creator_role": 2
  }
}

返回结果

返回结果

状态码状态码含义说明数据模型
200OK成功Inline
状态码状态码含义说明数据模型
200OK成功Inline

返回数据结构

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenone状态码none
» messagestringtruenone信息none
» dataobjecttruenonenone
»» idstringtruenone分享 IDnone
»» expiresstringtruenone过期时间未设置时为""
»» pwdstringtruenone分享码未设置时为""
»» accessedintegertruenone访问数none
»» max_accessedintegertruenone最大访问数未设置时为0
»» disabledbooleantruenone是否被禁用none
»» remarkstringtruenone备注none
»» readmestringtruenone说明none
»» headerstringtruenone头部说明none
»» order_bystringtruenone排序方式有效值有"name", "size", "modified", ""
»» order_directionstringtruenone排序方向有效值有"asc", "desc", ""
»» extract_folderstringtruenone提取文件夹有效值有"front", "back", ""
»» files[string]truenone分享路径none
»» creatorstringtruenone分享创建者用户名none
»» creator_roleintegertruenone分享创建者角色0: 普通用户,1: 访客,2: 管理员

状态码 200

名称类型必选约束中文名说明
» codeintegertruenone状态码none
» messagestringtruenone信息none
» dataobjecttruenonenone
»» idstringtruenone分享 IDnone
»» expiresstringtruenone过期时间未设置时为""
»» pwdstringtruenone分享码未设置时为""
»» accessedintegertruenone访问数none
»» max_accessedintegertruenone最大访问数未设置时为0
»» disabledbooleantruenone是否被禁用none
»» remarkstringtruenone备注none
»» readmestringtruenone说明none
»» headerstringtruenone头部说明none
»» order_bystringtruenone排序方式有效值有"name", "size", "modified", ""
»» order_directionstringtruenone排序方向有效值有"asc", "desc", ""
»» extract_folderstringtruenone提取文件夹有效值有"front", "back", ""
»» files[string]truenone分享路径none
»» creatorstringtruenone分享创建者用户名none
»» creator_roleintegertruenone分享创建者角色0: 普通用户,1: 访客,2: 管理员

POST 更新分享信息

POST 更新分享信息

POST /api/share/update

Body 请求参数

json
{
  "id": "j20jfpiY",
  "expires": "2024-12-30T18:32:12.4250369+08:00",
  "pwd": "z8YB0",
  "accessed": 2,
  "max_accessed": 0,
  "disabled": false,
  "remark": "",
  "readme": "",
  "header": "",
  "order_by": "name",
  "order_direction": "asc",
  "extract_folder": "front",
  "files": ["/tt/test.rar"]
}

POST /api/share/update

Body 请求参数

json
{
  "id": "j20jfpiY",
  "expires": "2024-12-30T18:32:12.4250369+08:00",
  "pwd": "z8YB0",
  "accessed": 2,
  "max_accessed": 0,
  "disabled": false,
  "remark": "",
  "readme": "",
  "header": "",
  "order_by": "name",
  "order_direction": "asc",
  "extract_folder": "front",
  "files": ["/tt/test.rar"]
}

请求参数

请求参数

名称位置类型必选中文名说明
Authorizationheaderstringtoken
Content-Typeheaderstringnone
bodybodyobjectnone
» idstringtruenone被更新分享 IDnone
» expiresstringtruenone过期时间取消设置时为""
» pwdstringtruenone分享码取消设置时为""
» accessedintegertruenone访问数none
» max_accessedintegertruenone最大访问数取消设置时为0
» disabledbooleantruenone是否被禁用none
» remarkstringtruenone备注none
» readmestringtruenone说明none
» headerstringtruenone头部说明none
» order_bystringtruenone排序方式有效值有"name", "size", "modified", ""
» order_directionstringtruenone排序方向有效值有"asc", "desc", ""
» extract_folderstringtruenone提取文件夹有效值有"front", "back", ""
» files[string]truenone被分享文件路径none
名称位置类型必选中文名说明
Authorizationheaderstringtoken
Content-Typeheaderstringnone
bodybodyobjectnone
» idstringtruenone被更新分享 IDnone
» expiresstringtruenone过期时间取消设置时为""
» pwdstringtruenone分享码取消设置时为""
» accessedintegertruenone访问数none
» max_accessedintegertruenone最大访问数取消设置时为0
» disabledbooleantruenone是否被禁用none
» remarkstringtruenone备注none
» readmestringtruenone说明none
» headerstringtruenone头部说明none
» order_bystringtruenone排序方式有效值有"name", "size", "modified", ""
» order_directionstringtruenone排序方向有效值有"asc", "desc", ""
» extract_folderstringtruenone提取文件夹有效值有"front", "back", ""
» files[string]truenone被分享文件路径none

返回示例

返回示例

成功

json
{
  "code": 200,
  "message": "success",
  "data": {
    "id": "j20jfpiY",
    "expires": "2024-12-30T18:32:12.4250369+08:00",
    "pwd": "z8YB0",
    "accessed": 2,
    "max_accessed": 0,
    "disabled": false,
    "remark": "",
    "readme": "",
    "header": "",
    "order_by": "name",
    "order_direction": "asc",
    "extract_folder": "front",
    "files": ["/tt/test.rar"],
    "creator": "admin",
    "creator_role": 2
  }
}

成功

json
{
  "code": 200,
  "message": "success",
  "data": {
    "id": "j20jfpiY",
    "expires": "2024-12-30T18:32:12.4250369+08:00",
    "pwd": "z8YB0",
    "accessed": 2,
    "max_accessed": 0,
    "disabled": false,
    "remark": "",
    "readme": "",
    "header": "",
    "order_by": "name",
    "order_direction": "asc",
    "extract_folder": "front",
    "files": ["/tt/test.rar"],
    "creator": "admin",
    "creator_role": 2
  }
}

返回结果

返回结果

状态码状态码含义说明数据模型
200OK成功Inline
状态码状态码含义说明数据模型
200OK成功Inline

返回数据结构

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenone状态码none
» messagestringtruenone信息none
» dataobjecttruenonenone
»» idstringtruenone分享 IDnone
»» expiresstringtruenone过期时间未设置时为""
»» pwdstringtruenone分享码未设置时为""
»» accessedintegertruenone访问数none
»» max_accessedintegertruenone最大访问数未设置时为0
»» disabledbooleantruenone是否被禁用none
»» remarkstringtruenone备注none
»» readmestringtruenone说明none
»» headerstringtruenone头部说明none
»» order_bystringtruenone排序方式有效值有"name", "size", "modified", ""
»» order_directionstringtruenone排序方向有效值有"asc", "desc", ""
»» extract_folderstringtruenone提取文件夹有效值有"front", "back", ""
»» files[string]truenone分享路径none
»» creatorstringtruenone分享创建者用户名none
»» creator_roleintegertruenone分享创建者角色0: 普通用户,1: 访客,2: 管理员

状态码 200

名称类型必选约束中文名说明
» codeintegertruenone状态码none
» messagestringtruenone信息none
» dataobjecttruenonenone
»» idstringtruenone分享 IDnone
»» expiresstringtruenone过期时间未设置时为""
»» pwdstringtruenone分享码未设置时为""
»» accessedintegertruenone访问数none
»» max_accessedintegertruenone最大访问数未设置时为0
»» disabledbooleantruenone是否被禁用none
»» remarkstringtruenone备注none
»» readmestringtruenone说明none
»» headerstringtruenone头部说明none
»» order_bystringtruenone排序方式有效值有"name", "size", "modified", ""
»» order_directionstringtruenone排序方向有效值有"asc", "desc", ""
»» extract_folderstringtruenone提取文件夹有效值有"front", "back", ""
»» files[string]truenone分享路径none
»» creatorstringtruenone分享创建者用户名none
»» creator_roleintegertruenone分享创建者角色0: 普通用户,1: 访客,2: 管理员

POST 删除分享

POST 删除分享

POST /api/share/delete

POST /api/share/delete

请求参数

请求参数

名称位置类型必选中文名说明
idquerystring分享 IDnone
Authorizationheaderstringtoken
名称位置类型必选中文名说明
idquerystring分享 IDnone
Authorizationheaderstringtoken

返回示例

返回示例

成功

json
{
  "code": 200,
  "message": "success",
  "data": null
}

成功

json
{
  "code": 200,
  "message": "success",
  "data": null
}

返回结果

返回结果

状态码状态码含义说明数据模型
200OK成功Inline
状态码状态码含义说明数据模型
200OK成功Inline

返回数据结构

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenone状态码none
» messagestringtruenone信息none
» datanulltruenonenone

状态码 200

名称类型必选约束中文名说明
» codeintegertruenone状态码none
» messagestringtruenone信息none
» datanulltruenonenone

POST 启用分享

POST 启用分享

POST /api/share/enable

POST /api/share/enable

请求参数

请求参数

名称位置类型必选中文名说明
idquerystring分享 IDnone
Authorizationheaderstringtoken
名称位置类型必选中文名说明
idquerystring分享 IDnone
Authorizationheaderstringtoken

返回示例

返回示例

成功

json
{
  "code": 200,
  "message": "success",
  "data": null
}

成功

json
{
  "code": 200,
  "message": "success",
  "data": null
}

返回结果

返回结果

状态码状态码含义说明数据模型
200OK成功Inline
状态码状态码含义说明数据模型
200OK成功Inline

返回数据结构

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenone状态码none
» messagestringtruenone信息none
» datanulltruenonenone

状态码 200

名称类型必选约束中文名说明
» codeintegertruenone状态码none
» messagestringtruenone信息none
» datanulltruenonenone

POST 禁用分享

POST 禁用分享

POST /api/share/disable

POST /api/share/disable

请求参数

请求参数

名称位置类型必选中文名说明
idquerystring分享 IDnone
Authorizationheaderstringtoken
名称位置类型必选中文名说明
idquerystring分享 IDnone
Authorizationheaderstringtoken

返回示例

返回示例

成功

json
{
  "code": 200,
  "message": "success",
  "data": null
}

成功

json
{
  "code": 200,
  "message": "success",
  "data": null
}

返回结果

返回结果

状态码状态码含义说明数据模型
200OK成功Inline
状态码状态码含义说明数据模型
200OK成功Inline

返回数据结构

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenone状态码none
» messagestringtruenone信息none
» datanulltruenonenone

状态码 200

名称类型必选约束中文名说明
» codeintegertruenone状态码none
» messagestringtruenone信息none
» datanulltruenonenone

Contributors