API 参考
RadStudio 后端提供 RESTful API,支持所有平台功能的编程访问。
基础信息
| 项目 | 说明 |
|---|---|
| 基础 URL | http://localhost:8000/api |
| 认证方式 | Bearer Token (JWT) |
| 内容类型 | application/json |
| Swagger UI | http://localhost:8000/docs |
| ReDoc | http://localhost:8000/redoc |
认证
所有 API 请求需要在 Header 中携带 JWT Token:
curl -H "Authorization: Bearer <your_token>" `http://localhost:8000/api/projects`
详见 认证接口。
API 模块
| 模块 | 前缀 | 说明 |
|---|---|---|
| 认证 | /api/auth | 登录、注册、Token 刷新 |
| 项目 | /api/projects | 项目 CRUD、数据管理 |
| 训练任务 | /api/training | 训练任务提交、查询、管理 |
| 内部接口 | /internal | 服务间通信、Worker 回调 |
错误响应
所有错误响应格式统一:
{
"detail": "错误描述信息"
}
常见 HTTP 状态码:
| 状态码 | 说明 |
|---|---|
| 200 | 成功 |
| 201 | 创建成功 |
| 400 | 请求参数错误 |
| 401 | 未认证 |
| 403 | 无权限 |
| 404 | 资源不存在 |
| 422 | 请求体验证失败 |
| 500 | 服务器内部错误 |
分页
列表接口支持分页:
GET /api/projects?page=1&page_size=20
响应格式:
{
"items": [...],
"total": 100,
"page": 1,
"page_size": 20
}