设置配置

1. 接口定位

• 接口名称: 设置配置
• 所属域: admin/config
• 业务目标: 将指定配置内容写入 ETCD 配置中心

2. 请求定义

• Method: POST
• Path: /config/set_config
• Content-Type: 推荐 application/json
• operationID: 必填，请通过 Header operationID 传入
• 鉴权: 需要 Header token，且必须是管理员 token
• 幂等性: 对相同配置内容重复提交可视为幂等

3. 请求参数

Header 参数

字段	必填	类型	说明
operationID	是	string	链路追踪 ID
token	是	string	管理员 token

Body 参数

字段	必填	类型	说明
configName	是	string	配置文件名
data	是	string	配置 JSON 字符串

支持的 configName

• discovery.yml
• log.yml
• mongodb.yml
• chat-api-admin.yml
• chat-api-chat.yml
• chat-rpc-admin.yml
• chat-rpc-chat.yml
• share.yml
• redis.yml

字段约束

• 当前接口只在 Discovery.Enable == ETCD 时可用；非 ETCD 模式直接返回错误。
• data 必须是与 configName 对应配置结构匹配的 JSON 字符串。
• 若 configName 不在上述支持列表中，当前实现返回通用参数错误。

4. 响应结构

通用响应包裹

字段	类型	说明
errCode	int	错误码，0 表示成功
errMsg	string	错误简述
errDlt	string	错误详情
data	any	业务数据

data 字段

• 本接口成功时返回 null。

5. 业务规则

• 仅管理员可以调用。
• 服务端会根据 configName 选择对应 Go 配置结构体，把 data 反序列化后与当前内存配置做 reflect.DeepEqual 比较。
• 如果新旧配置完全一致，接口直接返回成功，不写入 ETCD。
• 如果配置不同，则把新的 JSON 内容写入 etcd.BuildKey(configName)。

6. 错误码与失败场景

错误码	场景	典型报错
-	非 ETCD 模式	only etcd support set config
1001	请求 JSON 解析失败	由 BindJSON 详细错误组成
1001	data 不是合法 JSON	由 JSON Unmarshal 详细错误组成
1001	configName 不受支持	通用 ArgsError
1001	写入 ETCD 前比较/序列化失败	由错误详情组成
-	写入 ETCD 失败	save to etcd failed

7. 示例

fetch 请求示例

fetch("http://localhost:10009/config/set_config", {
  method: "POST",
  headers: {
    operationID: "550e8400-e29b-41d4-a716-446655440803",
    token: "eyJhbGciOi...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    configName: "redis.yml",
    data: JSON.stringify({
      address: ["127.0.0.1:6379"],
      db: 0,
    }),
  }),
})
  .then((res) => res.json())
  .then((data) => console.log(data));

请求示例（JSON）

{
  "configName": "redis.yml",
  "data": "{\"address\":[\"127.0.0.1:6379\"],\"db\":0}"
}

成功响应示例

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": null
}

8. 时序流程

1. 中间件校验管理员 token。
2. 校验当前部署是否启用 ETCD 配置中心。
3. 解析 configName 与 data。
4. 将 data 反序列化到对应配置结构。
5. 与当前内存配置比较；有变化时写入 ETCD。
6. 返回统一成功响应。

9. 变更记录

• 2026-03-31: 首版发布，基于配置中心写入和差异比较逻辑补全文档。