📝 主要改进: • Cursor配置模块化:拆分为前端、后端、移动端、文档、API测试5个专门规范文件 • API文档重新组织:按业务模块拆分到docs/开发文档/API/目录下 • 新增维修分类功能完整测试方案和自动化测试脚本 • 后端热启动脚本完善,支持Linux/Windows双平台 • 强化文档同步更新规范,确保代码与文档一致性 🔧 技术改进: • 优化Cursor AI工作流程和代码生成质量 • 完善API测试规范(AES+RSA双重加密登录方法) • 提升开发效率和代码质量标准化程度 �� 测试覆盖: • 维修分类管理功能端到端测试验证通过 • 包含页面加载、CRUD操作、搜索功能等核心测试用例 更新时间:2025-07-01
2.7 KiB
2.7 KiB
API 接口文档 (已迁移)
📢 重要通知
API 文档已于 2025-07-01 进行重构拆分,请使用新的文档架构!
🔗 新文档位置
主要入口: API 文档总览.md
📊 按业务模块查找
| 原有内容 | 新文档位置 | 说明 |
|---|---|---|
| 基础规范、请求头、响应格式 | API 文档基础规范.md | 必读基础规范 |
| 用户登录、认证、用户信息 | 用户认证登录 API.md | 认证相关接口 |
| 维修分类、报修工单管理 | 物业报修管理 API.md | 物业报修接口 |
| 问卷管理、答题功能 | 后勤满意度调查 API.md | 满意度调查接口 |
🎯 快速跳转
🔍 常用接口直达
- 🔐 用户登录: 用户认证登录 API.md#用户登录
- 🛠️ 报修工单: 物业报修管理 API.md#查询报修工单列表
- 📊 问卷答题: 后勤满意度调查 API.md#提交问卷答案
📋 开发指南
- 首次开发: 请先阅读 API 文档基础规范.md
- 功能开发: 根据业务模块选择对应的 API 文档
- 完整导航: 查看 API 文档总览.md
✨ 新架构优势
- 📝 中文命名: 便于快速识别和查找
- 🔧 模块化管理: 独立维护,减少冲突
- 📊 按需查阅: 根据开发需要选择相应文档
- 🔗 交叉引用: 各文档间建立引用关系
- 📚 总览导航: 统一的文档入口和索引
🔄 迁移说明
📅 迁移时间线
- 2025-07-01: 完成 API 文档拆分重构
- 向后兼容: 本文件作为重定向,保持链接有效性
- 推荐使用: 新的模块化 API 文档架构
🚨 开发者注意事项
- 更新书签: 将书签更新为新的文档链接
- 团队通知: 通知团队成员使用新的文档架构
- 文档引用: 更新其他文档中对 API.md 的引用
📞 需要帮助?
如有疑问或需要帮助,请:
- 查看 API 文档总览.md 获取完整导航
- 联系开发团队
- 查看项目仓库的 Issues
📝 维护: API 文档迁移重定向页面
🔄 更新: 2025-07-01
🎯 目标: 提供向后兼容的文档访问方式