Skip to content

设置注册开关

1. 接口定位

  • 接口名称: 设置注册开关
  • 所属域: admin/allow-register
  • 业务目标: 打开或关闭普通用户注册能力

2. 请求定义

  • Method: POST
  • Path: /user/allow_register/set
  • Content-Type: 推荐 application/json
  • operationID: 必填,请通过 Header operationID 传入
  • 鉴权: 需要 Header token,且必须是管理员 token
  • 幂等性: 对相同布尔值幂等

3. 请求参数

Header 参数

字段必填类型说明
operationIDstring链路追踪 ID
tokenstring管理员 token

Body 参数

字段必填类型说明
allowRegisterbooltrue 允许普通注册;false 禁止普通注册

4. 响应结构

通用响应包裹

字段类型说明
errCodeint错误码,0 表示成功
errMsgstring错误简述
errDltstring错误详情
dataobject业务数据

data 字段

  • 成功时返回空对象。

5. 业务规则

  • 仅要求调用方是管理员。
  • chat RPC 会把 AllowRegister 直接更新为请求中的布尔值。
  • 当前实现只修改当前 chat 进程中的开关状态;是否持久化不在这条代码路径中处理。

6. 错误码与失败场景

错误码场景典型报错
1001未传 tokentoken is empty
1001token 类型不是管理员token type error
-token 解析失败ParseToken 链路返回

7. 示例

fetch 请求示例

javascript
fetch("http://localhost:10009/user/allow_register/set", {
  method: "POST",
  headers: {
    operationID: "550e8400-e29b-41d4-a716-446655440202",
    token: "eyJhbGciOi...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    allowRegister: false,
  }),
})
  .then((res) => res.json())
  .then((data) => console.log(data));

请求示例(JSON)

json
{
  "allowRegister": false
}

成功响应示例

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

失败响应示例

json
{
  "errCode": 1001,
  "errMsg": "ArgsError",
  "errDlt": "token is empty"
}

8. 时序流程

  1. 中间件校验管理员 token。
  2. 解析 allowRegister 布尔值。
  3. chat RPC 更新内存中的注册开关。
  4. 返回统一成功响应。

9. 变更记录

  • 2026-03-31: 首版发布,基于 allow-register 设置路由与 chat RPC 状态更新逻辑补全文档。