BadWord API

概述

BadWord API是用于管理 Fess 屏蔽词（不适当的建议词排除）的API。 您可以设置不希望在建议功能中显示的关键词。

基础URL

/api/admin/badword

端点列表

方法 路径 说明
GET/PUT /settings 获取屏蔽词列表
GET /setting/{id} 获取屏蔽词
POST /setting 创建屏蔽词
PUT /setting 更新屏蔽词
DELETE /setting/{id} 删除屏蔽词

获取屏蔽词列表

请求

GET /api/admin/badword/settings
PUT /api/admin/badword/settings

参数

参数 类型 必需 说明
size Integer 否 每页记录数（默认：20）
page Integer 否 页码（从0开始）

响应

{
  "response": {
    "status": 0,
    "settings": [
      {
        "id": "badword_id_1",
        "suggestWord": "inappropriate_word",
        "targetRole": "",
        "targetLabel": ""
      }
    ],
    "total": 5
  }
}

获取屏蔽词

请求

GET /api/admin/badword/setting/{id}

响应

{
  "response": {
    "status": 0,
    "setting": {
      "id": "badword_id_1",
      "suggestWord": "inappropriate_word",
      "targetRole": "",
      "targetLabel": ""
    }
  }
}

创建屏蔽词

请求

POST /api/admin/badword/setting
Content-Type: application/json

请求体

{
  "suggestWord": "spam_keyword",
  "targetRole": "guest",
  "targetLabel": ""
}

字段说明

字段 必需 说明
suggestWord 是 要排除的关键词
targetRole 否 目标角色（为空时适用于所有角色）
targetLabel 否 目标标签（为空时适用于所有标签）

响应

{
  "response": {
    "status": 0,
    "id": "new_badword_id",
    "created": true
  }
}

更新屏蔽词

请求

PUT /api/admin/badword/setting
Content-Type: application/json

请求体

{
  "id": "existing_badword_id",
  "suggestWord": "updated_spam_keyword",
  "targetRole": "guest",
  "targetLabel": "",
  "versionNo": 1
}

响应

{
  "response": {
    "status": 0,
    "id": "existing_badword_id",
    "created": false
  }
}

删除屏蔽词

请求

DELETE /api/admin/badword/setting/{id}

响应

{
  "response": {
    "status": 0,
    "id": "deleted_badword_id",
    "created": false
  }
}

使用示例

排除垃圾关键词

curl -X POST "http://localhost:8080/api/admin/badword/setting" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "suggestWord": "spam",
       "targetRole": "",
       "targetLabel": ""
     }'

针对特定角色的屏蔽词

curl -X POST "http://localhost:8080/api/admin/badword/setting" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "suggestWord": "internal",
       "targetRole": "guest",
       "targetLabel": ""
     }'

参考信息