import{_ as i,c as a,o as t,ag as n}from"./chunks/framework.BmLMQRXF.js";const E=JSON.parse('{"title":"FileCodeBox API Documentation","description":"","frontmatter":{},"headers":[],"relativePath":"en/api/index.md","filePath":"en/api/index.md","lastUpdated":1739330962000}'),e={name:"en/api/index.md"};function h(l,s,p,d,k,r){return t(),a("div",null,s[0]||(s[0]=[n(`

FileCodeBox API Documentation ​

API Version: 2.1.0 ​

Table of Contents ​

Authentication ​

Some APIs require Authorization header for authentication:

Authorization: Bearer <token>

Share API ​

Share Text ​

POST /share/text/

Share text content and get a share code.

Parameters:

ParameterTypeRequiredDefaultDescription
textstringYes-Text content to share
expire_valueintegerNo1Expiration time value
expire_stylestringNo"day"Expiration time unit(day/hour/minute)

Response Example:

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

Share File ​

POST /share/file/

Upload and share a file, get a share code.

Parameters:

ParameterTypeRequiredDefaultDescription
filefileYes-File to upload
expire_valueintegerNo1Expiration time value
expire_stylestringNo"day"Expiration time unit(day/hour/minute)

Response Example:

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

Get File Info ​

GET /share/select/

Get file information by share code.

Parameters:

ParameterTypeRequiredDescription
codestringYesFile share code

Response Example:

json
{
  "code": 200,
  "msg": "success",
  "detail": {
    "code": "abc123",
    "name": "example.txt",
    "size": 1024,
    "text": "File content or download link"
  }
}

Select File ​

POST /share/select/

Select file by share code.

Parameters:

ParameterTypeRequiredDescription
codestringYesFile share code

Response Example:

json
{
  "code": 200,
  "msg": "success",
  "detail": {
    "code": "abc123",
    "name": "example.txt",
    "size": 1024,
    "text": "File content or download link"
  }
}

Download File ​

GET /share/download

Download shared file.

Parameters:

ParameterTypeRequiredDescription
keystringYesDownload key
codestringYesFile share code

Admin API ​

Admin Login ​

POST /admin/login

Admin login to get token.

Parameters:

ParameterTypeRequiredDescription
passwordstringYesAdmin password

Dashboard Data ​

GET /admin/dashboard

Get system dashboard data.

Response Example:

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

File List ​

GET /admin/file/list

Get system file list.

Parameters:

ParameterTypeRequiredDefaultDescription
pageintegerNo1Current page
sizeintegerNo10Page size
keywordstringNo""Search keyword

Response Example:

json
{
  "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 File ​

DELETE /admin/file/delete

Delete file from system.

Parameters:

ParameterTypeRequiredDescription
idintegerYesFile ID

Get Config ​

GET /admin/config/get

Get system configuration.

Update Config ​

PATCH /admin/config/update

Update system configuration.

Error Response ​

When an error occurs, the API will return corresponding error message:

json
{
  "code": 422,
  "detail": [
    {
      "loc": ["body", "password"],
      "msg": "Password cannot be empty",
      "type": "value_error"
    }
  ]
}

Status Codes ​

`,75)]))}const g=i(e,[["render",h]]);export{E as __pageData,g as default};