docs: 交接景区列表 deinfo 契约 (#5405) #67
@ -0,0 +1,83 @@
|
||||
---
|
||||
schema: "hl-changelog/v2"
|
||||
ticket: "5405"
|
||||
title: "景区列表新增 deinfo 返回参数"
|
||||
consumer: "multiple"
|
||||
change_type: "修改接口"
|
||||
backend_status: "pending"
|
||||
gateway_status: "pending"
|
||||
frontend_status: "pending"
|
||||
frontend_owner: ""
|
||||
frontend_ref: ""
|
||||
target_release: ""
|
||||
verified_at: ""
|
||||
status_note: "后端 PR #5406 已创建,待合并 xr 并完成测试环境网关验证"
|
||||
updated_at: "2026-08-01"
|
||||
base: "xr"
|
||||
---
|
||||
|
||||
# 景区管理:列表新增 deinfo 返回参数
|
||||
|
||||
> **服务**:hl-resource-service
|
||||
> **PR**:#5406
|
||||
> **Issue**:#5405
|
||||
> **日期**:2026-08-01
|
||||
> **影响范围**:管理后台景区管理列表;内部小程序景区列表会兼容性携带该新增字段
|
||||
|
||||
## 一、变更接口
|
||||
|
||||
| 接口 | 方法 | 路径 | 变更 |
|
||||
|---|---|---|---|
|
||||
| 景区管理查询列表 | GET | `/admin/scenic/spots` | 每条列表记录新增 `deinfo` |
|
||||
|
||||
同一响应 VO 也用于内部接口 `GET /internal/mp/scenic/list`。小程序服务以
|
||||
`Map<String, Object>` 接收并只读取已有字段,因此新增字段不会改变现有聚合结果。
|
||||
|
||||
## 二、响应字段
|
||||
|
||||
| 字段 | 类型 | 必填性 | 值 | 说明 |
|
||||
|---|---|---|---|---|
|
||||
| `deinfo` | `String` | 列表有记录时每条必返 | 固定为 `文旅info` | 景区扩展信息 |
|
||||
|
||||
响应示例:
|
||||
|
||||
```json
|
||||
{
|
||||
"code": 200,
|
||||
"data": {
|
||||
"records": [
|
||||
{
|
||||
"scenicId": "1001",
|
||||
"name": "九寨沟",
|
||||
"deinfo": "文旅info"
|
||||
}
|
||||
],
|
||||
"total": 1,
|
||||
"current": 1,
|
||||
"size": 20
|
||||
},
|
||||
"success": true
|
||||
}
|
||||
```
|
||||
|
||||
空列表仍沿用原分页结构,`records` 为 `[]`,不会生成占位记录。
|
||||
|
||||
## 三、兼容性与前端事项
|
||||
|
||||
- 这是向后兼容的响应字段扩展,不修改请求参数、分页结构、查询条件或既有字段。
|
||||
- 管理后台可直接读取每条记录的 `deinfo`;当前值固定为 `文旅info`。
|
||||
- 后端未修改 `mmg/hl-ui`,前端消费状态保持 `pending`。
|
||||
|
||||
## 四、验证
|
||||
|
||||
- 独立 JSON 契约测试:2 项通过,确认字段名为 `deinfo` 且每条记录值为 `文旅info`。
|
||||
- `hl-resource-service` reactor:1712 项测试通过,0 失败;38 项为仓库既有跳过测试。
|
||||
- `hl-mp-service` 景区聚合消费方:13 项测试通过,0 失败。
|
||||
- oasdiff:`not_configured`,一期项目没有稳定 OAS3 导出与已配置工具,使用源码和 JSON 序列化测试回退。
|
||||
- Spring Cloud Contract:`not_configured`,使用生产者及消费者 reactor 测试回退。
|
||||
- 测试环境部署和网关验证尚未执行,因此 `backend_status`、`gateway_status` 保持 `pending`。
|
||||
|
||||
## 五、关联
|
||||
|
||||
- [后端工单 #5405](https://git.1814.love:8443/wx/HL/issues/5405)
|
||||
- [后端 PR #5406](https://git.1814.love:8443/wx/HL/pulls/5406)
|
||||
正在加载...
x
在新工单中引用
屏蔽一个用户