跳到主要内容

API 参考

RadStudio 后端提供 RESTful API,支持所有平台功能的编程访问。

基础信息

项目说明
基础 URLhttp://localhost:8000/api
认证方式Bearer Token (JWT)
内容类型application/json
Swagger UIhttp://localhost:8000/docs
ReDochttp://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
}