访问方式

FastapiAdmin 基于 FastAPI 自动生成 API 文档，支持两种格式：

格式	本地地址	在线地址
Swagger UI	http://127.0.0.1:8001/docs	https://service.fastapiadmin.com/api/v1/docs
Redoc	http://127.0.0.1:8001/redoc	https://service.fastapiadmin.com/api/v1/redoc

使用方法

1. 打开 Swagger UI，点击右上角 Authorize 按钮
2. 输入用户名密码完成认证
3. 找到目标接口 → Try it out → 填写参数 → Execute

API 接口分类

• 系统管理：用户、角色、菜单、部门、岗位等
• 监控管理：在线用户、服务器监控、缓存监控
• 任务管理：定时任务
• 日志管理：操作日志
• 开发工具：代码生成、表单构建

响应格式

所有接口统一响应格式：

{
  "code": 200,
  "message": "success",
  "data": {}
}

分页响应

{
  "code": 200,
  "message": "success",
  "data": {
    "items": [],
    "total": 100,
    "page": 1,
    "pageSize": 10
  }
}

前端 API 调用

Web 端

API 封装按模块组织在 frontend/web/src/api/ 下：

api/
├── module_monitor/   # 监控模块接口
├── module_system/    # 系统模块接口
│   ├── auth.ts       # 认证
│   ├── user.ts       # 用户
│   ├── role.ts       # 角色
│   └── menu.ts       # 菜单
└── module_example/   # 示例接口

调用示例：

import { authApi } from "@/api/module_system/auth";

const login = async (username: string, password: string) => {
  const res = await authApi.login({ username, password });
  // 保存 token，获取用户信息，跳转首页
};

移动端

API 封装在 frontend/app/src/api/ 下，调用方式类似：

import { authApi } from "@/api/auth";

const login = async (username: string, password: string) => {
  const res = await authApi.login({ username, password });
  userStore.setToken(res.data.token);
  uni.switchTab({ url: "/pages/index/index" });
};

API 设计规范

规范	说明
URL	小写 + 下划线，资源路径复数，版本号在 URL 前缀
GET	获取资源
POST	创建资源
PUT	更新资源
DELETE	删除资源

常见问题

问题	解决方案
401 认证失败	检查登录状态是否过期，重新登录
403 权限不足	联系管理员分配权限
422 参数错误	检查请求参数是否正确
500 服务器错误	查看后端日志定位原因