Skip to content

index.md

Latest commit

 

History

History
263 lines (190 loc) · 4.28 KB

index.md

File metadata and controls

263 lines (190 loc) · 4.28 KB

FileCodeBox API 文档

API 版本: 2.1.0

目录

认证

部分接口需要在请求头中携带 Authorization 进行认证：

Authorization: Bearer <token>

分享接口

分享文本

POST /share/text/

分享文本内容，获取分享码。

请求参数：

参数名 类型 必填 默认值 描述
text string 是 - 要分享的文本内容
expire_value integer 否 1 过期时间值
expire_style string 否 "day" 过期时间单位(day/hour/minute)

响应示例：

{
  "code": 200,
  "msg": "success",
  "detail": {
    "code": "abc123",
    "name": "text.txt"
  }
}

分享文件

POST /share/file/

上传并分享文件，获取分享码。

请求参数：

参数名 类型 必填 默认值 描述
file file 是 - 要上传的文件
expire_value integer 否 1 过期时间值
expire_style string 否 "day" 过期时间单位(day/hour/minute)

响应示例：

{
  "code": 200,
  "msg": "success",
  "detail": {
    "code": "abc123",
    "name": "example.txt"
  }
}

获取文件信息

GET /share/select/

通过分享码获取文件信息。

请求参数：

参数名 类型 必填 描述
code string 是 文件分享码

响应示例：

{
  "code": 200,
  "msg": "success",
  "detail": {
    "code": "abc123",
    "name": "example.txt",
    "size": 1024,
    "text": "文件内容或下载链接"
  }
}

选择文件

POST /share/select/

通过分享码选择文件。

请求参数：

参数名 类型 必填 描述
code string 是 文件分享码

响应示例：

{
  "code": 200,
  "msg": "success",
  "detail": {
    "code": "abc123",
    "name": "example.txt",
    "size": 1024,
    "text": "文件内容或下载链接"
  }
}

下载文件

GET /share/download

下载分享的文件。

请求参数：

参数名 类型 必填 描述
key string 是 下载密钥
code string 是 文件分享码

管理接口

管理员登录

POST /admin/login

管理员登录获取token。

请求参数：

参数名 类型 必填 描述
password string 是 管理员密码

仪表盘数据

GET /admin/dashboard

获取系统仪表盘数据。

响应示例：

{
  "code": 200,
  "msg": "success",
  "detail": {
    "totalFiles": 100,
    "storageUsed": "1.5GB",
    "sysUptime": "10天",
    "yesterdayCount": 50,
    "yesterdaySize": "500MB",
    "todayCount": 30,
    "todaySize": "300MB"
  }
}

文件列表

GET /admin/file/list

获取系统中的文件列表。

请求参数：

参数名 类型 必填 默认值 描述
page integer 否 1 当前页码
size integer 否 10 每页数量
keyword string 否 "" 搜索关键词

响应示例：

{
  "code": 200,
  "msg": "success",
  "detail": {
    "page": 1,
    "size": 10,
    "total": 100,
    "data": [
      {
        "id": 1,
        "name": "example.txt",
        "size": 1024,
        "created_at": "2024-01-01 12:00:00"
      }
    ]
  }
}

删除文件

DELETE /admin/file/delete

删除系统中的文件。

请求参数：

参数名 类型 必填 描述
id integer 是 文件ID

获取配置

GET /admin/config/get

获取系统配置信息。

更新配置

PATCH /admin/config/update

更新系统配置信息。

错误响应

当发生错误时，API会返回对应的错误信息：

{
  "code": 422,
  "detail": [
    {
      "loc": ["body", "password"],
      "msg": "密码不能为空",
      "type": "value_error"
    }
  ]
}

状态码说明

  • 200: 请求成功
  • 401: 未授权
  • 403: 禁止访问
  • 404: 资源不存在
  • 422: 请求参数验证错误
  • 500: 服务器内部错误