源丰后端 API

Appearance

API 变更日志 ​

本记录了源丰后端API的所有重要变更，包括新增功能、接口变更、错误修复等。

📋 变更类型说明 ​

  • 🆕 新增 (Added): 新增的功能或接口
  • 🔧 改进 (Changed): 现有功能的改进
  • 🗑️ 移除 (Removed): 移除的功能或接口
  • ⚠️ 废弃 (Deprecated): 即将移除的功能
  • 🐛 修复 (Fixed): 错误修复
  • 🔒 安全 (Security): 安全相关的修复或改进
  • 💥 破坏性变更 (Breaking Changes): 不兼容的变更

[v1.2.0] - 2024-01-24 ​

🆕 新增 ​

  • 薪资分类管理模块: 新增薪资分类的完整CRUD操作

    • POST /admin/salary-categories - 创建薪资分类
    • GET /admin/salary-categories - 获取薪资分类列表
    • GET /admin/salary-categories/{id} - 获取薪资分类详情
    • PUT /admin/salary-categories/{id} - 更新薪资分类
    • DELETE /admin/salary-categories/{id} - 删除薪资分类

  • 日报系统模块: 新增员工日报提交和管理功能

    • POST /daily-reports - 创建日报
    • GET /daily-reports - 获取日报列表
    • GET /daily-reports/{id} - 获取日报详情
    • PUT /daily-reports/{id} - 更新日报
    • DELETE /daily-reports/{id} - 删除日报
    • GET /daily-reports/my - 获取我的日报
    • GET /daily-reports/stats - 获取日报统计

  • 考勤组管理: 完善考勤组管理功能

    • POST /admin/attendance/groups - 创建考勤组
    • GET /admin/attendance/groups/{id}/employees - 获取考勤组员工列表

  • Postman集合: 提供完整的API测试集合

  • 开发者文档: 完善的快速开始指南和最佳实践

🔧 改进 ​

  • 错误处理: 统一错误响应格式，增加详细错误码
  • 数据格式: 规范化日期时间、金额等数据格式
  • 文档完善: 补充所有API模块的详细文档
  • 性能优化: 优化数据库查询和响应时间

🐛 修复 ​

  • 分页问题: 修复列表接口分页参数错误
  • 权限验证: 修复部分接口权限验证逻辑
  • 参数验证: 修复请求参数验证不严格的问题

📚 文档 ​

  • 新增完整的API文档系统，基于VitePress构建
  • 添加错误码对照表和数据格式说明
  • 创建部署指南和环境配置文档
  • 提供多语言代码示例和最佳实践

[v1.1.0] - 2024-01-15 ​

🆕 新增 ​

  • 批量操作接口:

    • PATCH /admin/salaries/batch-status - 批量更新薪资状态
    • POST /todos/{id}/batch-assign - 批量指派待办事项
    • POST /admin/contacts/batch-sync - 批量同步通讯录

  • 文件管理增强:

    • POST /oss/batch-upload - 批量上传文件
    • DELETE /oss/batch-delete - 批量删除文件
    • POST /oss/presigned-url - 生成预签名URL

  • 消息管理增强:

    • POST /admin/messages/global - 发送全局消息
    • GET /messages/stats - 获取用户消息统计

🔧 改进 ​

  • 权限系统: 优化Casbin权限检查性能
  • 缓存机制: 增加Redis缓存支持
  • 日志系统: 完善日志记录和轮转

🐛 修复 ​

  • 并发安全: 修复高并发场景下的数据竞争问题
  • 内存泄漏: 修复文件上传导致的内存泄漏
  • 超时处理: 优化长时间请求的超时处理

[v1.0.0] - 2024-01-01 ​

🆕 新增 ​

  • 用户认证系统: JWT token认证，支持登录注册
  • 用户管理: 个人资料管理、密码修改
  • 员工管理: 员工档案、组织架构管理
  • 公司管理: 多公司支持、企业信息管理
  • 部门管理: 部门组织、层级管理
  • 考勤管理: 打卡记录、考勤统计、规则配置
  • 薪资管理: 薪资计算、发放管理、统计分析
  • 待办事项: 任务管理、分配跟踪、状态管理
  • 合同管理: 员工合同、协议管理
  • 银行账户: 员工银行信息管理
  • 文件管理: 文件上传下载、OSS存储
  • 消息通知: 系统消息、用户通知
  • 角色权限: RBAC权限控制、角色管理
  • 通讯录: 企业通讯录、联系人管理
  • 公司入驻: 企业加入申请、审批流程

🔧 改进 ​

  • 架构设计: 采用四层清洁架构模式
  • 数据库设计: 完善的表结构和关系设计
  • API设计: RESTful API设计规范
  • 错误处理: 统一的错误处理机制
  • 日志记录: 完整的日志记录体系

📚 文档 ​

  • 完整的Swagger API文档
  • 数据库设计文档
  • 部署和运维文档

📅 版本规划 ​

v1.3.0 (计划中) ​

  • [ ] 数据分析模块: 业务数据统计和分析
  • [ ] 报表系统: 自动生成各类业务报表
  • [ ] 导入导出: 支持Excel、CSV格式数据导入导出
  • [ ] 消息推送: 移动端推送通知支持

v1.4.0 (计划中) ​

  • [ ] 工作流引擎: 审批流程自定义
  • [ ] 任务调度: 定时任务和调度管理
  • [ ] API限流: 更精细的API访问控制
  • [ ] 性能监控: 集成APM性能监控

v2.0.0 (远期规划) ​

  • [ ] 微服务拆分: 核心模块微服务化
  • [ ] GraphQL支持: 提供GraphQL API接口
  • [ ] 实时通信: WebSocket实时消息推送
  • [ ] 国际化支持: 多语言和时区支持

🔄 API版本管理 ​

版本策略 ​

  • 主版本号: 不兼容的API变更
  • 次版本号: 向后兼容的功能性新增
  • 修订版本号: 向后兼容的问题修正

版本支持 ​

  • 当前版本: v1.2.x (积极维护)
  • 稳定版本: v1.1.x (仅修复安全问题)
  • 废弃版本: v1.0.x (不再维护)

升级指南 ​

从 v1.1.x 升级到 v1.2.x ​

  1. 数据库迁移: 运行新的数据库迁移脚本
  2. 配置更新: 添加新的环境变量配置
  3. 客户端更新: 更新API调用以使用新的薪资分类和日报接口

从 v1.0.x 升级到 v1.1.x ​

  1. 兼容性检查: 确认现有功能兼容性
  2. 测试验证: 在测试环境验证所有功能
  3. 逐步迁移: 分批次进行生产环境升级

⚠️ 破坏性变更说明 ​

v1.2.0 破坏性变更 ​

薪资接口变更 ​

  • 变更内容: 薪资计算逻辑调整，支持薪资分类
  • 影响范围: 薪资计算和发放相关接口
  • 迁移方案: 需要先配置薪资分类，再进行薪资计算

响应格式变更 ​

  • 变更内容: 统一错误响应格式，增加错误码字段
  • 影响范围: 所有API接口的错误响应
  • 迁移方案: 更新客户端错误处理逻辑

v1.1.0 破坏性变更 ​

权限系统变更 ​

  • 变更内容: 使用Casbin替换原有权限系统
  • 影响范围: 所有需要权限验证的接口
  • 迁移方案: 重新配置权限策略和用户角色

🔧 开发和发布流程 ​

开发流程 ​

  1. 功能开发: 在feature分支进行功能开发
  2. 代码审查: 提交PR进行代码审查
  3. 测试验证: 在测试环境进行完整测试
  4. 文档更新: 更新相关API文档
  5. 合并发布: 合并到主分支并发布

发布流程 ​

  1. 版本标记: 创建git tag标记版本
  2. 构建发布: 自动构建和部署
  3. 数据库迁移: 自动执行数据库迁移
  4. 监控验证: 验证服务运行状态
  5. 公告通知: 发布版本更新公告

回滚策略 ​

  1. 快速回滚: 发现严重问题时立即回滚到上一版本
  2. 问题修复: 修复问题后重新发布
  3. 根因分析: 分析问题原因，制定预防措施

📞 联系我们 ​

如果您在使用API过程中遇到问题或有改进建议：

维护团队: 源丰后端开发团队 更新频率: 每月发布一次版本，紧急修复随时发布 文档维护: 与代码版本同步更新

基于 MIT 许可发布

Copyright © 2024-2025 源丰科技