336 lines
10 KiB
Markdown
336 lines
10 KiB
Markdown
# API 变更日志
|
||
|
||
## 1. 版本 1.0.0 (2024-01-01)
|
||
|
||
### 1.1 新增功能
|
||
|
||
- **认证模块**：
|
||
- 新增 `POST /api/v1/auth/login` 接口：用户登录
|
||
- 新增 `POST /api/v1/auth/register` 接口：用户注册
|
||
- 新增 `GET /api/v1/auth/me` 接口：获取当前用户信息
|
||
|
||
- **商品模块**：
|
||
- 新增 `POST /api/v1/products` 接口：创建商品
|
||
- 新增 `GET /api/v1/products` 接口：获取商品列表
|
||
- 新增 `GET /api/v1/products/{id}` 接口：获取商品详情
|
||
- 新增 `PUT /api/v1/products/{id}` 接口：更新商品
|
||
- 新增 `DELETE /api/v1/products/{id}` 接口：删除商品
|
||
|
||
- **订单模块**：
|
||
- 新增 `POST /api/v1/orders` 接口：创建订单
|
||
- 新增 `GET /api/v1/orders` 接口：获取订单列表
|
||
- 新增 `GET /api/v1/orders/{id}` 接口：获取订单详情
|
||
- 新增 `PUT /api/v1/orders/{id}` 接口：更新订单
|
||
- 新增 `DELETE /api/v1/orders/{id}` 接口：删除订单
|
||
|
||
- **支付模块**：
|
||
- 新增 `POST /api/v1/payments` 接口：创建支付
|
||
- 新增 `GET /api/v1/payments` 接口：获取支付列表
|
||
- 新增 `GET /api/v1/payments/{id}` 接口：获取支付详情
|
||
- 新增 `PUT /api/v1/payments/{id}` 接口：更新支付
|
||
|
||
- **物流模块**：
|
||
- 新增 `POST /api/v1/logistics` 接口：创建物流
|
||
- 新增 `GET /api/v1/logistics` 接口：获取物流列表
|
||
- 新增 `GET /api/v1/logistics/{id}` 接口：获取物流详情
|
||
- 新增 `PUT /api/v1/logistics/{id}` 接口：更新物流
|
||
|
||
- **用户模块**：
|
||
- 新增 `POST /api/v1/users` 接口：创建用户
|
||
- 新增 `GET /api/v1/users` 接口：获取用户列表
|
||
- 新增 `GET /api/v1/users/{id}` 接口：获取用户详情
|
||
- 新增 `PUT /api/v1/users/{id}` 接口：更新用户
|
||
- 新增 `DELETE /api/v1/users/{id}` 接口：删除用户
|
||
|
||
- **监控模块**：
|
||
- 新增 `GET /api/v1/monitoring/health` 接口：系统健康状态
|
||
- 新增 `GET /api/v1/monitoring/ping` 接口：系统响应测试
|
||
- 新增 `GET /api/v1/monitoring/metrics` 接口：系统性能指标
|
||
|
||
- **告警模块**：
|
||
- 新增 `POST /api/v1/alerts` 接口：创建告警
|
||
- 新增 `GET /api/v1/alerts` 接口：获取告警列表
|
||
- 新增 `GET /api/v1/alerts/{id}` 接口：获取告警详情
|
||
- 新增 `PUT /api/v1/alerts/{id}` 接口：更新告警
|
||
- 新增 `PUT /api/v1/alerts/{id}/resolve` 接口：解决告警
|
||
|
||
- **配置模块**：
|
||
- 新增 `POST /api/v1/configs` 接口：创建配置
|
||
- 新增 `GET /api/v1/configs` 接口：获取配置列表
|
||
- 新增 `GET /api/v1/configs/{id}` 接口：获取配置详情
|
||
- 新增 `PUT /api/v1/configs/{id}` 接口：更新配置
|
||
- 新增 `DELETE /api/v1/configs/{id}` 接口：删除配置
|
||
|
||
- **审计模块**：
|
||
- 新增 `GET /api/v1/audit` 接口：获取审计日志列表
|
||
- 新增 `GET /api/v1/audit/{id}` 接口：获取审计日志详情
|
||
|
||
- **数据模块**：
|
||
- 新增 `POST /api/v1/data/import` 接口：导入数据
|
||
- 新增 `GET /api/v1/data/export` 接口：导出数据
|
||
|
||
- **报表模块**：
|
||
- 新增 `GET /api/v1/reports/sales` 接口：销售报表
|
||
- 新增 `GET /api/v1/reports/inventory` 接口：库存报表
|
||
- 新增 `GET /api/v1/reports/users` 接口：用户报表
|
||
|
||
### 1.2 变更内容
|
||
|
||
- **认证模块**：
|
||
- 使用 JWT 进行认证
|
||
- 支持角色授权
|
||
|
||
- **商品模块**：
|
||
- 支持商品分页查询
|
||
- 支持商品搜索
|
||
|
||
- **订单模块**：
|
||
- 支持订单状态流转
|
||
- 支持订单查询
|
||
|
||
- **支付模块**：
|
||
- 支持多种支付方式
|
||
- 支持支付状态更新
|
||
|
||
- **物流模块**：
|
||
- 支持物流状态更新
|
||
- 支持物流查询
|
||
|
||
- **用户模块**：
|
||
- 支持用户角色管理
|
||
- 支持用户权限控制
|
||
|
||
- **监控模块**：
|
||
- 支持系统健康检查
|
||
- 支持系统性能监控
|
||
|
||
- **告警模块**：
|
||
- 支持告警级别管理
|
||
- 支持告警状态更新
|
||
|
||
- **配置模块**：
|
||
- 支持配置类型管理
|
||
- 支持配置查询
|
||
|
||
- **审计模块**：
|
||
- 支持审计日志查询
|
||
- 支持审计日志过滤
|
||
|
||
- **数据模块**：
|
||
- 支持数据导入导出
|
||
- 支持数据格式转换
|
||
|
||
- **报表模块**：
|
||
- 支持销售报表生成
|
||
- 支持库存报表生成
|
||
- 支持用户报表生成
|
||
|
||
### 1.3 修复问题
|
||
|
||
- **认证模块**：
|
||
- 修复登录失败时的错误处理
|
||
- 修复注册时的参数验证
|
||
|
||
- **商品模块**：
|
||
- 修复商品创建时的参数验证
|
||
- 修复商品更新时的权限检查
|
||
|
||
- **订单模块**：
|
||
- 修复订单创建时的状态设置
|
||
- 修复订单更新时的权限检查
|
||
|
||
- **支付模块**：
|
||
- 修复支付创建时的参数验证
|
||
- 修复支付状态更新时的错误处理
|
||
|
||
- **物流模块**：
|
||
- 修复物流创建时的参数验证
|
||
- 修复物流状态更新时的错误处理
|
||
|
||
- **用户模块**：
|
||
- 修复用户创建时的参数验证
|
||
- 修复用户更新时的权限检查
|
||
|
||
- **监控模块**：
|
||
- 修复健康检查端点的响应格式
|
||
- 修复性能指标的计算
|
||
|
||
- **告警模块**：
|
||
- 修复告警创建时的参数验证
|
||
- 修复告警状态更新时的错误处理
|
||
|
||
- **配置模块**：
|
||
- 修复配置创建时的参数验证
|
||
- 修复配置更新时的权限检查
|
||
|
||
- **审计模块**：
|
||
- 修复审计日志查询时的参数验证
|
||
- 修复审计日志过滤时的错误处理
|
||
|
||
- **数据模块**：
|
||
- 修复数据导入时的格式验证
|
||
- 修复数据导出时的格式转换
|
||
|
||
- **报表模块**：
|
||
- 修复销售报表生成时的计算错误
|
||
- 修复库存报表生成时的计算错误
|
||
- 修复用户报表生成时的计算错误
|
||
|
||
## 2. 版本 1.1.0 (2024-02-01)
|
||
|
||
### 2.1 新增功能
|
||
|
||
- **认证模块**：
|
||
- 新增 `POST /api/v1/auth/refresh` 接口：刷新 token
|
||
- 新增 `POST /api/v1/auth/logout` 接口：用户登出
|
||
|
||
- **商品模块**：
|
||
- 新增 `GET /api/v1/products/categories` 接口：获取商品分类
|
||
- 新增 `POST /api/v1/products/batch` 接口：批量创建商品
|
||
|
||
- **订单模块**：
|
||
- 新增 `POST /api/v1/orders/batch` 接口：批量创建订单
|
||
- 新增 `GET /api/v1/orders/status` 接口：获取订单状态统计
|
||
|
||
- **支付模块**：
|
||
- 新增 `POST /api/v1/payments/batch` 接口：批量创建支付
|
||
- 新增 `GET /api/v1/payments/status` 接口：获取支付状态统计
|
||
|
||
- **物流模块**：
|
||
- 新增 `POST /api/v1/logistics/batch` 接口：批量创建物流
|
||
- 新增 `GET /api/v1/logistics/status` 接口：获取物流状态统计
|
||
|
||
- **用户模块**：
|
||
- 新增 `POST /api/v1/users/batch` 接口：批量创建用户
|
||
- 新增 `GET /api/v1/users/roles` 接口：获取用户角色
|
||
|
||
- **监控模块**：
|
||
- 新增 `GET /api/v1/monitoring/health/detail` 接口：详细健康状态
|
||
- 新增 `GET /api/v1/monitoring/metrics/detail` 接口：详细性能指标
|
||
|
||
- **告警模块**：
|
||
- 新增 `POST /api/v1/alerts/batch` 接口：批量创建告警
|
||
- 新增 `GET /api/v1/alerts/severity` 接口：获取告警严重程度统计
|
||
|
||
- **配置模块**：
|
||
- 新增 `POST /api/v1/configs/batch` 接口：批量创建配置
|
||
- 新增 `GET /api/v1/configs/types` 接口：获取配置类型
|
||
|
||
- **审计模块**：
|
||
- 新增 `GET /api/v1/audit/actions` 接口：获取审计操作类型
|
||
- 新增 `GET /api/v1/audit/resources` 接口：获取审计资源类型
|
||
|
||
- **数据模块**：
|
||
- 新增 `POST /api/v1/data/import/batch` 接口：批量导入数据
|
||
- 新增 `GET /api/v1/data/export/batch` 接口：批量导出数据
|
||
|
||
- **报表模块**：
|
||
- 新增 `GET /api/v1/reports/sales/detail` 接口：详细销售报表
|
||
- 新增 `GET /api/v1/reports/inventory/detail` 接口：详细库存报表
|
||
- 新增 `GET /api/v1/reports/users/detail` 接口：详细用户报表
|
||
|
||
### 2.2 变更内容
|
||
|
||
- **认证模块**：
|
||
- 优化 JWT 认证逻辑
|
||
- 支持 token 过期时间配置
|
||
|
||
- **商品模块**：
|
||
- 优化商品搜索逻辑
|
||
- 支持商品分类管理
|
||
|
||
- **订单模块**：
|
||
- 优化订单状态流转逻辑
|
||
- 支持订单批量操作
|
||
|
||
- **支付模块**：
|
||
- 优化支付处理逻辑
|
||
- 支持支付批量操作
|
||
|
||
- **物流模块**：
|
||
- 优化物流处理逻辑
|
||
- 支持物流批量操作
|
||
|
||
- **用户模块**：
|
||
- 优化用户角色管理逻辑
|
||
- 支持用户批量操作
|
||
|
||
- **监控模块**：
|
||
- 优化健康检查逻辑
|
||
- 支持详细性能指标
|
||
|
||
- **告警模块**：
|
||
- 优化告警处理逻辑
|
||
- 支持告警批量操作
|
||
|
||
- **配置模块**：
|
||
- 优化配置管理逻辑
|
||
- 支持配置批量操作
|
||
|
||
- **审计模块**：
|
||
- 优化审计日志查询逻辑
|
||
- 支持审计操作类型和资源类型查询
|
||
|
||
- **数据模块**：
|
||
- 优化数据导入导出逻辑
|
||
- 支持数据批量操作
|
||
|
||
- **报表模块**：
|
||
- 优化报表生成逻辑
|
||
- 支持详细报表生成
|
||
|
||
### 2.3 修复问题
|
||
|
||
- **认证模块**：
|
||
- 修复 token 刷新时的错误处理
|
||
- 修复登出时的 token 失效处理
|
||
|
||
- **商品模块**：
|
||
- 修复商品分类查询时的错误处理
|
||
- 修复商品批量创建时的参数验证
|
||
|
||
- **订单模块**：
|
||
- 修复订单批量创建时的参数验证
|
||
- 修复订单状态统计时的计算错误
|
||
|
||
- **支付模块**：
|
||
- 修复支付批量创建时的参数验证
|
||
- 修复支付状态统计时的计算错误
|
||
|
||
- **物流模块**：
|
||
- 修复物流批量创建时的参数验证
|
||
- 修复物流状态统计时的计算错误
|
||
|
||
- **用户模块**：
|
||
- 修复用户批量创建时的参数验证
|
||
- 修复用户角色查询时的错误处理
|
||
|
||
- **监控模块**：
|
||
- 修复详细健康状态查询时的错误处理
|
||
- 修复详细性能指标查询时的计算错误
|
||
|
||
- **告警模块**：
|
||
- 修复告警批量创建时的参数验证
|
||
- 修复告警严重程度统计时的计算错误
|
||
|
||
- **配置模块**：
|
||
- 修复配置批量创建时的参数验证
|
||
- 修复配置类型查询时的错误处理
|
||
|
||
- **审计模块**：
|
||
- 修复审计操作类型查询时的错误处理
|
||
- 修复审计资源类型查询时的错误处理
|
||
|
||
- **数据模块**：
|
||
- 修复数据批量导入时的格式验证
|
||
- 修复数据批量导出时的格式转换
|
||
|
||
- **报表模块**：
|
||
- 修复详细销售报表生成时的计算错误
|
||
- 修复详细库存报表生成时的计算错误
|
||
- 修复详细用户报表生成时的计算错误
|
||
|
||
## 3. 总结
|
||
|
||
本 API 变更日志详细记录了 Crawlful Hub 项目的 API 变更历史。通过本日志，您可以了解 API 的新增功能、变更内容和修复问题，便于 API 的使用和维护。
|