功能说明
提供按平台切换、按名称搜索、按创建时间倒序的小区资源列表接口,返回剩余条数、历史使用总计、本月使用以及低库存统计用于顶部预警。
文件位置
- Controller: src/controller/smsCommunityController.ts
- Service: src/service/smsCommunityService.ts
- Model: src/model/smsCommunity.ts
接口定义
| 请求方式 | GET |
| 请求路径 | /api/v1/sms/communities |
请求参数
| 参数名 | 类型 | 必填 | 说明 |
| platformId | number | 是 | 平台ID |
| keyword | string | 否 | 小区名称模糊匹配 |
| page/pageSize | number | 否 | 分页 |
响应格式
{
"code":200,
"data":{
"list":[{"id":1,"name":"小区A","remain":900,"usedTotal":2000,"usedMonth":300,"createdAt":"2024-03-01"}],
"lowStockCount":1,
"total":1
},
"message":"success"
}
业务逻辑
- 参数校验:platformId必填正整数;分页默认page=1,pageSize=20
- 权限检查:需具备查看该平台下小区资源权限
- 数据处理:查询平台下小区按创建时间倒序;按名称过滤;统计剩余<1000的小区数量;返回列表含剩余、本月/历史使用
- 返回结果:列表、分页、lowStockCount用于预警提示
错误处理
| 400 | 参数错误 | 缺少platformId或分页无效 |
| 403 | 无权限 | 无该平台查看权限 |
| 404 | 数据不存在 | 平台不存在 |
验收标准
- 列表按创建时间倒序
- 搜索后仅返回匹配名称的小区
- lowStockCount准确统计剩余<1000