这个提交包含在:
+12
-2
@@ -3,7 +3,8 @@ schema: "hl-changelog/v2"
|
||||
ticket: "{issue-no}"
|
||||
title: "{一句话概括变化}"
|
||||
consumer: "{admin|mp|internal|multiple}"
|
||||
author: "{推送者登录名}(GIT)" # 如 wx(GIT)/yst(GIT),谁 push 到 main 就写谁
|
||||
# author 示例: wx(GIT) / yst(GIT);谁 push 到 main 就写谁
|
||||
author: "{推送者登录名}(GIT)"
|
||||
change_type: "{新增接口|修改接口|删除接口}"
|
||||
backend_status: "pending"
|
||||
gateway_status: "pending"
|
||||
@@ -67,6 +68,10 @@ base: "{dev|dev-v3}"
|
||||
|
||||
**VO**: `{VO 类名}`
|
||||
|
||||
#### 使用场景
|
||||
|
||||
说明前端在什么页面、什么时机调用;多接口条目中每个接口都必须自包含,不依赖其他章节补参数或错误语义。
|
||||
|
||||
#### 入参
|
||||
|
||||
| 字段 | 位置 | 类型 | 必填 | 约束 | 说明 |
|
||||
@@ -113,9 +118,14 @@ base: "{dev|dev-v3}"
|
||||
}
|
||||
```
|
||||
|
||||
#### 业务边界
|
||||
|
||||
- 写清本接口自己的鉴权、空值、状态、幂等/并发、失败零写入和兼容规则。
|
||||
- 不要只在全局章节写一次;消费方应能单独阅读本接口小节完成联调。
|
||||
|
||||
---
|
||||
|
||||
## 四、契约约束与正确调用方式(选填,字段互斥/联动/切换场景必写)
|
||||
## 四、契约约束与正确调用方式(接口类必写)
|
||||
|
||||
> 本节只写**后端接受/拒绝 payload 的规则**,不写 UI 渲染建议。
|
||||
|
||||
|
||||
在新工单中引用
屏蔽一个用户