删除客户端配置
1. 接口定位
- 接口名称: 删除客户端配置
- 所属域: admin/client-config
- 业务目标: 按配置键名批量删除客户端初始化配置项
2. 请求定义
- Method:
POST - Path:
/client_config/del - Content-Type: 推荐
application/json - operationID: 必填,请通过 Header
operationID传入 - 鉴权: 需要 Header
token,且必须是管理员 token - 幂等性: 弱幂等;不存在的键不会单独报未找到错误
3. 请求参数
Header 参数
| 字段 | 必填 | 类型 | 说明 |
|---|---|---|---|
| operationID | 是 | string | 链路追踪 ID |
| token | 是 | string | 管理员 token |
Body 参数
| 字段 | 必填 | 类型 | 说明 |
|---|---|---|---|
| keys | 否 | array<string> | 要删除的配置键名列表 |
字段约束
- 当前协议层没有为
keys定义显式Check()校验。 - RPC 层也不会校验
keys是否为空或是否为null;空列表最终表现为删除 0 条记录。
4. 响应结构
通用响应包裹
| 字段 | 类型 | 说明 |
|---|---|---|
| errCode | int | 错误码,0 表示成功 |
| errMsg | string | 错误简述 |
| errDlt | string | 错误详情 |
| data | object | 业务数据 |
data 字段
- 本接口成功时返回空对象(无业务字段)。
5. 业务规则
- 仅管理员可以调用。
- 删除条件是
key in keys。 - 不会先检查目标键是否存在,也不会返回实际删除数量。
6. 错误码与失败场景
| 错误码 | 场景 | 典型报错 |
|---|---|---|
| - | 数据库删除失败 | 由数据库层返回原始错误 |
7. 示例
fetch 请求示例
javascript
fetch("http://localhost:10009/client_config/del", {
method: "POST",
headers: {
operationID: "550e8400-e29b-41d4-a716-446655440506",
token: "eyJhbGciOi...",
"Content-Type": "application/json",
},
body: JSON.stringify({
keys: ["registerWelcomeText", "defaultLanguage"],
}),
})
.then((res) => res.json())
.then((data) => console.log(data));请求示例(JSON)
json
{
"keys": ["registerWelcomeText", "defaultLanguage"]
}成功响应示例
json
{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": {}
}8. 时序流程
- 中间件校验管理员 token。
- 读取请求中的
keys。 - 按
key in keys删除客户端配置项。 - 返回统一成功响应。
9. 变更记录
- 2026-03-31: 首版发布,基于客户端配置按键删除逻辑补全文档。