API 接口文档
欢迎使用源丰后端 API 文档。这里包含了所有接口的详细说明和示例。
按模块浏览
基础模块
企业模块
业务模块
- 待办事项 - 任务管理、分配跟踪
- 薪资管理 - 薪资计算、发放管理
- 薪资分类 - 薪资分类管理
- 日报系统 - 员工日报提交管理
- 考勤管理 - 打卡记录、考勤统计
- 合同管理 - 员工合同、协议管理
- 银行账户 - 员工银行信息
工具模块
快速导航
🚀 快速开始
📋 接口概览
| 模块 | 主要功能 | 接口数量 |
|---|---|---|
| 用户认证 | 注册、登录、token 管理 | 2 |
| 用户管理 | 个人资料、密码管理 | 4 |
| 员工管理 | 员工档案、组织架构 | 10 |
| 待办事项 | 任务管理、分配跟踪 | 23 |
| 薪资管理 | 薪资计算、发放管理 | 10 |
| 薪资分类 | 薪资分类管理 | 5 |
| 日报系统 | 员工日报提交管理 | 7 |
| 考勤管理 | 打卡记录、考勤统计 | 25 |
| 合同管理 | 员工合同、协议管理 | 6 |
| 银行账户 | 员工银行信息 | 5 |
| 文件管理 | 文件上传下载、OSS 存储 | 10 |
| 公司管理 | 企业信息、多公司支持 | 11 |
| 部门管理 | 部门组织、层级管理 | 6 |
| 角色权限 | RBAC 权限控制 | 21 |
| 通讯录 | 企业通讯录、联系人管理 | 11 |
| 消息通知 | 系统消息、用户通知 | 15 |
| 公司入驻 | 企业加入申请 | 6 |
🔧 开发工具
- 在线 API 文档: http://localhost:8080/swagger/index.html
- 健康检查: http://localhost:8080/health
- API 测试: 支持 Postman、Insomnia 等工具
认证说明
大部分 API 接口需要认证才能访问：
- 获取 Token：使用登录接口获取 JWT token
- 携带 Token：在请求头中添加
Authorization: Bearer <token> - Token 有效期：24 小时，过期后需要重新登录
bash
# 示例：获取用户资料
curl -X GET http://localhost:8080/api/v1/users/profile \
-H "Authorization: Bearer your-jwt-token"响应格式
所有 API 响应都遵循统一的格式：
成功响应
json
{
"code": 200,
"message": "操作成功",
"data": {
// 具体数据内容
},
"timestamp": "2024-01-01T12:00:00Z"
}错误响应
json
{
"code": 400,
"message": "请求参数错误",
"error": "详细错误信息",
"timestamp": "2024-01-01T12:00:00Z"
}错误代码
| 代码 | 说明 | 描述 |
|---|---|---|
| 200 | 成功 | 请求处理成功 |
| 400 | 请求错误 | 请求参数格式错误或缺少必要参数 |
| 401 | 未认证 | 缺少有效的认证信息 |
| 403 | 无权限 | 用户没有权限访问该资源 |
| 404 | 资源不存在 | 请求的资源不存在 |
| 409 | 冲突 | 资源冲突，如邮箱已存在 |
| 500 | 服务器错误 | 服务器内部错误 |
支持与反馈
如果您在使用过程中遇到问题或有任何建议，请：
📖 继续阅读：建议从 用户认证 开始学习如何使用 API。