API 文档

欢迎使用 Terminal Electron API 文档。本文档详细描述了所有可用的API端点、请求格式和响应结构。

基础信息

基础URL: http://localhost:3000 (开发环境)
认证方式: JWT Bearer Token
内容类型: application/json

认证

大部分API端点需要JWT认证。在请求头中包含以下格式的Authorization头：

Authorization: Bearer <your-jwt-token>

API 端点概览

认证相关

服务器管理

SSH密钥管理

端口转发管理

团队管理

数据管理

错误响应格式

所有API在发生错误时都会返回以下格式的响应：

json

{
  "statusCode": 400,
  "message": "错误描述",
  "error": "Bad Request"
}

常见HTTP状态码：

200 - 请求成功
201 - 创建成功
400 - 请求参数错误
401 - 未认证
403 - 权限不足
404 - 资源不存在
500 - 服务器内部错误

分页和查询参数

对于列表接口，支持以下查询参数：

namespace - 团队命名空间（可选，个人数据为null）
page - 页码（可选，默认为1）
limit - 每页数量（可选，默认为10）

数据同步

系统支持本地数据与服务器数据的双向同步：

同步到服务器: 将本地数据上传到服务器
从服务器同步: 从服务器下载数据到本地

每个资源都提供了 sync 端点用于数据同步操作。

API 文档 ​

基础信息 ​

认证 ​

API 端点概览 ​

认证相关 ​

服务器管理 ​

SSH密钥管理 ​

端口转发管理 ​

团队管理 ​

数据管理 ​

错误响应格式 ​

分页和查询参数 ​

数据同步 ​