API 文档¶

概述¶

这里是FastAPI后端模板的完整API文档。所有API都遵循RESTful设计原则，使用JSON格式进行数据交换。

认证¶

大部分API需要JWT认证。请先通过登录接口获取访问令牌，然后在请求头中包含：

Authorization: Bearer <your-access-token>

响应格式¶

所有API响应都遵循统一的格式：

成功响应¶

{
  "code": 200,
  "msg": "success",
  "data": {...}
}

错误响应¶

{
  "code": 400,
  "msg": "error message",
  "data": null
}

错误码说明¶

错误码	说明
200	成功
400	请求参数错误
401	未认证
403	无权限
404	资源不存在
422	参数验证失败
429	请求过于频繁
500	服务器内部错误

API 模块¶

认证授权 - 用户登录、token刷新等
用户管理 - 用户CRUD操作
角色管理 - 角色权限管理
菜单管理 - 系统菜单配置
文件管理 - 文件上传下载
部门管理 - 组织架构管理
API权限 - API权限控制
审计日志 - 操作日志记录

在线测试¶

启动服务后，您可以通过以下地址访问交互式API文档：

Swagger UI: http://localhost:8000/docs
ReDoc: http://localhost:8000/redoc

请求限制¶

文件上传大小限制：10MB
登录尝试限制：5次/分钟
Token刷新限制：10次/分钟
API请求频率：根据具体接口而定

健康检查¶

健康状态: GET /api/v1/base/health
版本信息: GET /api/v1/base/version