系统模块

godo大约 3 分钟

系统事件

接口方法: HandleSystemEvents

注意：确保客户端支持 SSE 技术，并正确处理事件流。

描述: 该接口通过 HandleSystemEvents 方法处理客户端的系统事件连接，使用服务器发送事件（SSE）技术向客户端推送实时更新。客户端连接后，服务器会定期发送更新信息和本地聊天消息。成功时，客户端会持续接收事件流；如果客户端断开连接，服务器会停止发送。。

URL: /system/events
方法: GET
是否需要登录: false
请求参数: 无

返回参数:

参数名	类型	描述	示例值
message	string	提示信息	事件流中的消息类型和数据
data	object	事件数据	`{"Type": "update", "Data": {...}}`

示例

请求示例

curl -X GET curl -N "http://api.example.com/events"

成功响应示例

HTTP 状态码: 200 OK

  event: update
  data: {"Type": "update", "Data": {...}}

  event: localchat
  data: {"Type": "localchat", "Data": [...]}

错误响应示例

HTTP 状态码: 500 Internal Server Error

  {
    "message": "Error retrieving update info: [error details]"
  }

应用更新

接口方法: UpdateAppHandler

注意：确保 url 参数不为空，并且指向有效的更新文件。

描述: 该接口通过 UpdateAppHandler 方法处理客户端的更新请求，并返回应用的最新版本信息。

URL: /system/update
方法: GET
是否需要登录: false
请求参数:

参数名	类型	必填	描述	示例值
url	string	是	更新文件的 URL	"http://example.com/update.zip"
是否需要登录: false

返回参数:

参数名	类型	描述	示例值
updateCompleted	boolean	更新状态	true
message	string	提示信息	"url is empty" 或 "open file error" 或 "unzip error" 等

示例

请求示例

curl -X GET "http://api.example.com/system/update?url=http://example.com/update.zip"

成功响应示例

HTTP 状态码: 200 OK

  {
    "updateCompleted": true
  }

错误响应示例

URL 为空

HTTP 状态码: 400 Bad Request

  {
    "message": "url is empty"
  }

文件打开错误

HTTP 状态码: 500 Internal Server Error

  {
    "message": "open file error"
  }

解压缩错误

HTTP 状态码: 500 Internal Server Error

  {
    "message": "unzip error"
  }

更新失败

HTTP 状态码: 500 Internal Server Error

  {
    "message": "update error: [error details]"
  }

系统配置

接口方法: ConfigHandler

注意：确保配置文件路径正确，并且文件存在。

描述: 该接口通过 ConfigHandler 方法处理客户端的配置请求，并返回系统配置信息。

URL: /system/setting
方法: POST
是否需要登录: false
请求参数:

参数名	类型	必填	描述	示例值
Name	string	是	配置项名称	"osPath" 或 "webdavClient"
Value	any	是	配置项的值	"/path/to/dir" 或其他值

返回参数:

参数名	类型	描述	示例值
message	string	提示信息	"The config set success!" 或 "The params is error!" 或 "The Path is not exists!" 等
data	string	额外信息	"success" 或错误信息

示例

请求示例

curl -X POST "http://api.example.com/config" \
-H "Content-Type: application/json" \
-d '[{"Name": "osPath", "Value": "/path/to/dir"}, {"Name": "webdavClient", "Value": "clientConfig"}]'

成功响应示例

HTTP 状态码: 200 OK

  {
    "message": "The config set success!",
    "data": "success"
  }

错误响应示例

参数错误

HTTP 状态码: 400 Bad Request

  {
    "message": "The params is error!"
  }

路径不存在

HTTP 状态码: 400 Bad Request

  {
    "message": "The Path is not exists!"
  }

路径权限设置错误

HTTP 状态码: 500 Internal Server Error

  {
    "message": "The Path is not writable!"
  }

WebDAV 客户端初始化错误

HTTP 状态码: 500 Internal Server Error

  {
    "message": "The webdav client init is error: [error details]"
  }