API 概览
本章节整理前端、移动端和 6 种后端共同遵循的接口约定。日常联调时，建议先确认认证方式、统一响应格式和模块接口路径。
快速入口
| 你要做什么 | 推荐入口 |
|---|---|
| 了解接口规范 | 快速开始 |
| 对接登录、退出、刷新 Token | 认证接口 |
| 对接当前用户、用户列表 | 用户接口 |
| 对接角色和权限分配 | 角色接口 |
| 对接菜单和动态路由 | 菜单接口 |
| 对接组织架构 | 部门接口 |
| 对接字典和字典项 | 字典接口 |
| 对接系统配置 | 配置接口 |
| 对接通知公告 | 通知接口 |
| 对接日志查询 | 日志接口 |
| 对接文件上传 | 文件上传 |
| 对接 SSE 长连接 | SSE 接口 |
| 查询错误码 | 错误码速查 |
接口约定
| 约定 | 说明 |
|---|---|
| 基础路径 | /api/v1 |
| 认证方式 | Authorization: Bearer <accessToken> |
| 响应格式 | { code, msg, data } |
| 成功码 | 00000 |
| 分页参数 | pageNum、pageSize |
| 排序参数 | sortBy、order |
统一响应格式
json
{
"code": "00000",
"msg": "Success",
"data": {}
}常用接口速查
| 模块 | 方法 | 路径 | 说明 |
|---|---|---|---|
| 认证 | POST | /api/v1/auth/login | 账号密码登录 |
| 认证 | POST | /api/v1/auth/refresh-token | 刷新访问令牌 |
| 用户 | GET | /api/v1/users/me | 当前用户信息 |
| 菜单 | GET | /api/v1/menus/routes | 当前用户路由 |
| 字典 | GET | /api/v1/dicts/{dictCode}/items/options | 字典项选项 |
| 文件 | POST | /api/v1/files | 文件上传 |
| SSE | GET | /api/v1/sse/connect | 建立 SSE 连接 |
后端接口文档入口
| 后端 | 本地接口文档 |
|---|---|
| Java · Spring Boot | /doc.html |
| Node · NestJS | /api-docs |
| Go · Gin | /swagger/index.html |
| Python · Django | /api/docs/swagger/ |
| PHP · ThinkPHP | /swagger |
| C# · ASP.NET Core | /swagger |