功能说明
提供平台列表、默认首个平台加载,以及单个平台服务商信息、剩余条数、可分配条数、已分配未使用等资源概览查询接口,支撑页面平台切换与顶部卡片展示。
文件位置
- Controller: src/controller/smsPlatformController.ts
- Service: src/service/smsPlatformService.ts
- Model: src/model/smsPlatform.ts
接口定义
| 请求方式 | GET |
| 请求路径 | /api/v1/sms/platforms/overview |
请求参数
| 参数名 | 类型 | 必填 | 说明 |
| platformId | number | 否 | 不传则默认返回首个平台数据 |
响应格式
{
"code": 200,
"data": {
"platforms": [{"id":1,"name":"平台A"}],
"current": {
"id":1,
"name":"平台A",
"providerName":"XX服务商",
"remainCount":12000,
"allocatedUnused":2000,
"allocatable":10000
}
},
"message": "success"
}
业务逻辑
- 参数校验:platformId如传入需为正整数
- 权限检查:校验用户是否有平台资源查看权限
- 数据处理:查询平台列表按创建时间,选择首个或指定平台;聚合该平台下小区已分配未使用=SUM(已分配-已使用);可分配=平台剩余-已分配未使用;返回服务商名称与资源概览
- 返回结果:含平台列表、当前平台概览数据
错误处理
| 400 | 参数错误 | platformId非正整数 |
| 403 | 无权限 | 无查看权限 |
| 404 | 数据不存在 | 指定平台不存在 |
验收标准
- 默认不传platformId时返回首个平台及概览
- 切换platformId返回对应概览,计算逻辑与需求一致
- 异常参数与无权限时返回对应错误码