字典接口

接口列表

接口	方法	说明
/api/v1/dicts	GET	获取字典分页列表
/api/v1/dicts/options	GET	获取字典选项列表
/api/v1/dicts/{id}/form	GET	获取字典表单数据
/api/v1/dicts	POST	新增字典
/api/v1/dicts/{id}	PUT	修改字典
/api/v1/dicts/{ids}	DELETE	删除字典
/api/v1/dicts/{dictCode}/items	GET	获取字典项分页列表
/api/v1/dicts/{dictCode}/items/options	GET	获取字典项选项列表
/api/v1/dicts/{dictCode}/items	POST	新增字典项
/api/v1/dicts/{dictCode}/items/{id}/form	GET	获取字典项表单数据
/api/v1/dicts/{dictCode}/items/{id}	PUT	修改字典项
/api/v1/dicts/{dictCode}/items/{ids}	DELETE	删除字典项

获取字典分页列表

GET /api/v1/dicts?pageNum=1&pageSize=10&keywords=性别
Authorization: Bearer {accessToken}

响应示例：

{
  "code": "00000",
  "msg": "成功",
  "data": {
    "total": 1,
    "list": [
      {
        "id": "1",
        "name": "性别",
        "dictCode": "gender",
        "status": 1
      }
    ]
  }
}

获取字典项选项

GET /api/v1/dicts/gender/items/options
Authorization: Bearer {accessToken}

响应示例：

{
  "code": "00000",
  "msg": "成功",
  "data": [
    {
      "value": "1",
      "label": "男",
      "tagType": "primary"
    },
    {
      "value": "2",
      "label": "女",
      "tagType": "success"
    }
  ]
}

新增字典

POST /api/v1/dicts
Authorization: Bearer {accessToken}
Content-Type: application/json

{
  "name": "状态",
  "dictCode": "status",
  "status": 1,
  "remark": "通用状态字典"
}

新增字典项

POST /api/v1/dicts/status/items
Authorization: Bearer {accessToken}
Content-Type: application/json

{
  "label": "启用",
  "value": "1",
  "status": 1,
  "sort": 1,
  "tagType": "success"
}

字段说明

字典

字段	类型	必填	说明
name	string	是	字典名称
dictCode	string	是	字典编码
status	number	否	状态：1 启用，0 禁用
remark	string	否	备注

字典项

字段	类型	必填	说明
label	string	是	显示文本
value	string	是	字典值
status	number	否	状态：1 启用，0 禁用
sort	number	否	排序号
tagType	string	否	标签类型：primary / success / warning / info / danger

实时同步

字典数据变更后，前端可通过 SSE 接收变更事件并刷新本地缓存。详见 SSE 接口 和 字典系统。