API 契约
前端、移动端和所有后端共享同一份接口协议。完整的接口定义、请求/响应示例、Mock 数据请在 Apifox 在线文档中查看。
:cta[在线接口文档 →]{href="https://s.apifox.cn/195e783f-4d85-4235-a038-eec696de4ea5/api-426989926"}
接口约定
| 约定 | 说明 |
|---|---|
| 基础路径 | /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 | NestJS | Go | Django | PHP | ASP.NET |
|---|---|---|---|---|---|---|
| 基础路径 | /api/v1 | /api/v1 | /api/v1 | /api/v1 | /api/v1 | /api/v1 |
| 认证 | JWT+Security | JWT+Guard | JWT+Casbin | JWT | JWT | JWT |
| 分页 | pageNum/pageSize | 同左 | page/perPage | 同左 | 同左 | 同左 |
| 多租户 | ✅ 完整 | ❌ | ❌ | ❌ | ❌ | ❌ |
| SSE | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
各后端本地接口文档
| 后端 | 地址 |
|---|---|
| Java · Spring Boot | /doc.html (Knife4j) |
| Node · NestJS | /api-docs (Swagger) |
| Go · Gin | /swagger/index.html |
| Python · Django | /api/docs/swagger/ |
| PHP · ThinkPHP | /swagger |
| C# · ASP.NET Core | /swagger |
接口差异
认证接口
所有后端的登录/登出/刷新 Token 接口完全一致。
用户管理
| 功能 | Java | 其他后端差异 |
|---|---|---|
| 用户列表 | 支持 deptId 筛选 | 部分后端可能不支持 |
| 重置密码 | 返回新密码明文 | 可能返回空或加密串 |
文件上传
| 差异点 | 说明 |
|---|---|
| 大小限制 | 各后端默认不同，需查看配置 |
| 存储方式 | 本地/OSS/S3，各后端可配置 |
| 允许类型 | 默认 jpg/png/gif/pdf/doc/xls |