跳到主要内容

Nebula Dict 接口信息

本文档基于 nebula-dict-local 中当前已经实现的 DictController 整理，对外接口入口统一位于 /api/dict/**。

说明约定：

  • 所有接口返回统一 ApiResult
  • 分页接口统一使用 POST
  • 字典项支持平铺查询与树查询两种读取方式
  • onlyEnabled 不传时默认按 true 处理

1. 字典类型接口​

创建字典类型

创建一个新的字典类型，用于承载某一类业务枚举或业务分类。
POST/api/dict/types

更新字典类型

更新指定字典类型的名称、状态与备注。
PUT/api/dict/types/{id}

删除字典类型

删除指定字典类型。若该字典下仍有字典项，则服务端会拒绝删除。
DELETE/api/dict/types/{id}

字典类型详情

根据字典类型 ID 查询详情。
GET/api/dict/types/{id}

分页查询字典类型

按字典编码、名称、状态等条件分页查询字典类型。
POST/api/dict/types/page

2. 字典项接口​

创建字典项

创建新的字典项。既可创建平铺字典项，也可通过 parentId 创建树形字典子节点。
POST/api/dict/items

更新字典项

更新指定字典项的展示信息、状态、层级关系与扩展属性。修改 parentId 时服务端会自动维护 path。
PUT/api/dict/items/{id}

删除字典项

删除指定字典项。若该节点仍有子节点，服务端会拒绝删除。
DELETE/api/dict/items/{id}

字典项详情

根据字典项 ID 查询详情，返回层级信息、扩展属性与路径信息。
GET/api/dict/items/{id}

分页查询字典项

按字典编码、名称、状态等条件分页查询字典项。
POST/api/dict/items/page

3. 按字典编码读取接口​

按字典编码查询平铺字典项

按字典编码查询字典项平铺列表，适合下拉框、状态映射和简单枚举展示。
GET/api/dict/items/dict/{dictCode}

按字典编码查询字典项树

按字典编码查询字典项树，适合分类树、区域树和级联选择器。若当前结果集中父节点不存在，节点会以根节点形式返回。
GET/api/dict/items/dict/{dictCode}/tree