Files
dashboard/.qoder/repowiki/knowledge/zh/音频设备管理全栈平台/耳机管理后台 API/编码规范.md
T

4 lines
796 B
Markdown
Raw Normal View History

2026-06-30 14:46:52 +08:00
- 统一响应格式:所有 API 均通过 `utils/response.js` 中的 `ApiResponse` 对象返回标准化 JSON,包含 `code` (1:成功, 0:错误, 2:无数据), `msg``data` 字段。
- 集中式日志记录:使用 `winston` 配置的 `logger` 记录关键业务操作(如登录、创建/更新/删除资源)及错误信息,日志输出至 `logs/app.log`
- 路由级认证保护:受保护的路由组(如 brands, models, ota)在路由文件顶部通过 `router.use(authMiddleware)` 全局启用 JWT 验证,仅公开接口(如 `/health`, `/api/ota/latest/check`)例外。
- 参数空值处理:在更新操作中,显式检查请求体字段是否为 `undefined``'null'` 字符串,以区分“未提供”与“设为空”,避免意外覆盖现有数据。