Skip to content

删除违禁词词条

1. 接口定位

  • 接口名称: 删除违禁词词条
  • 所属域: admin/sensitive-word
  • 业务目标: 按词条文本批量删除违禁词

2. 请求定义

  • Method: POST
  • Path: /adminx/sensitive_word/del
  • Content-Type: 推荐 application/json
  • operationID: 必填,请通过 Header operationID 传入
  • 鉴权: 需要 Header token,且必须是管理员 token
  • 幂等性: 幂等;目标词条不存在时也返回成功

3. 请求参数

Header 参数

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

Body 参数

字段必填类型说明
wordsarray<string>要删除的词条

字段约束

  • 协议校验要求 words 非空。
  • 删除时按规范化词条执行(大小写和首尾空白不敏感)。

4. 响应结构

通用响应包裹

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

data 字段

  • 本接口成功时返回空对象(无业务字段)。

5. 业务规则

  • 删除按规范化词条(大小写和首尾空白不敏感)执行。
  • 词条不存在时不会报错。

6. 错误码与失败场景

错误码场景典型报错
1001words 为空words is empty
-数据库删除失败由数据库层返回错误

7. 示例

fetch 请求示例

javascript
fetch("http://localhost:10011/adminx/sensitive_word/del", {
  method: "POST",
  headers: {
    operationID: "sensitive-word-del-001",
    token: "eyJhbGciOi...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    words: ["spam", "fraud"],
  }),
})
  .then((res) => res.json())
  .then((data) => console.log(data));

请求示例(JSON)

json
{
  "words": ["spam", "fraud"]
}

成功响应示例

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

失败响应示例

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

8. 时序流程

  1. 中间件校验管理员 token。
  2. 校验 words 非空。
  3. 按规范化词条批量删除。
  4. 返回统一成功响应。

9. 变更记录

  • 2026-07-14: 文档重构为标准 admin API 模板,补齐 Header、响应结构、错误码和时序流程。