类 DictCategoryController
java.lang.Object
net.sohelp.boot.admin.core.base.BaseController
net.sohelp.boot.dev.web.system.dict.DictCategoryController
@RestController("dev-system-dict-category")
@RequestMapping("/dev/system/dict/category")
public class DictCategoryController
extends BaseController
字典分类管理控制器,提供对字典分类的增删改查及数据获取功能。
- 从以下版本开始:
- 2022/7/15
- 作者:
- AaronFung
-
字段概要
从类继承的字段 net.sohelp.boot.admin.core.base.BaseController
request, response -
构造器概要
构造器 -
方法概要
修饰符和类型方法说明添加新的字典分类记录。删除指定ID的字典分类及其关联的数据项。根据ID获取单个字典分类详细信息。getDataList(String dictName) 根据字典路径名获取对应的字典数据列表。获取所有符合条件的字典分类列表。分页查询字典分类信息。修改已有字典分类的信息。从类继承的方法 net.sohelp.boot.admin.core.base.BaseController
error, error, fail, fail, fail, getLoginID, getLoginName, getLoginOrgID, getLoginOrgName, getLoginUser, getNickname, getTenantId, getUserName, getUserNo, i18n, i18n, isAdministrator, isDeveloper, limit, offset, ok, ok, response, response, responseStream, success, success, success, success, validateToken
-
构造器详细资料
-
DictCategoryController
public DictCategoryController()
-
-
方法详细资料
-
page
@Permission("ADMIN") @GetMapping("/page") public ApiResult<Pager<Map<String,Object>>> page(@RequestParam Map<String, Object> paramMap) throws Exception分页查询字典分类信息。- 参数:
paramMap- 查询条件参数集合(如:页码、每页数量等)- 返回:
- 返回分页结果对象,包含当前页的数据列表及相关分页信息
- 抛出:
Exception- 查询过程中可能抛出异常
-
list
@GetMapping("/list") @Permission("ADMIN") public ApiResult<List<Map<String,Object>>> list(@RequestParam Map<String, Object> paramMap) throws Exception获取所有符合条件的字典分类列表。- 参数:
paramMap- 查询条件参数集合- 返回:
- 返回字典分类列表
- 抛出:
Exception- 查询过程中可能抛出异常
-
add
@PostMapping("/add") @Transactional(rollbackFor=java.lang.Exception.class) @Permission("ADMIN") @OperationLog("\u6dfb\u52a0\u5b57\u5178") public ApiResult<Map<String,Object>> add(@RequestBody Map<String, Object> paramMap) throws Exception添加新的字典分类记录。- 参数:
paramMap- 包含新增字段值的参数映射表- 返回:
- 成功时返回新增后的完整记录;失败则返回错误提示信息
- 抛出:
Exception- 操作中可能出现的异常
-
delete
@PostMapping("/delete") @Transactional(rollbackFor=java.lang.Exception.class) @Permission("sys:dict:remove") @OperationLog("\u5220\u9664\u5b57\u5178") public ApiResult<String> delete(@RequestBody Map<String, Object> paramMap) throws Exception删除指定ID的字典分类及其关联的数据项。- 参数:
paramMap- 请求参数,必须包含要删除的字典分类ID- 返回:
- 删除成功后返回确认消息
- 抛出:
Exception- 删除过程中的异常处理
-
getById
@GetMapping("/getById") @Permission("sys:dict:list") public ApiResult<Map<String,Object>> getById(@RequestParam String id) throws Exception 根据ID获取单个字典分类详细信息。- 参数:
id- 要查询的字典分类唯一标识符- 返回:
- 返回该字典分类的所有属性组成的Map结构
- 抛出:
Exception- 查询过程中的潜在异常
-
update
@PostMapping("/update") @Permission("DEVELOPER") public ApiResult<String> update(@RequestBody Map<String, Object> paramMap) throws Exception修改已有字典分类的信息。- 参数:
paramMap- 包含更新字段的新值- 返回:
- 更新成功的响应或错误原因
- 抛出:
Exception- 更新操作中可能发生的异常
-
getDataList
@GetMapping("/getDataList") @Permission("DEVELOPER") public ApiResult getDataList(@RequestParam String dictName) throws Exception 根据字典路径名获取对应的字典数据列表。- 参数:
dictName- 完整的字典路径名称,支持多层级以点号分割的形式- 返回:
- 返回解析后的字典数据列表,每个元素是一个键值对形式的对象
- 抛出:
Exception- 解析或查询过程中的异常情况
-