ClientApps/CN_Gather
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

调整接口注释

Browse Source
This commit is contained in:
caozehui
2025-11-04 14:35:16 +08:00
parent 563eb80b65
commit 57ee3a4d43
23 changed files with 87 additions and 216 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
system/src/main/java/com/njcn/gather/system/dictionary/controller/DictDataController.java
View File

@@ -99,7 +99,7 @@ public class DictDataController extends BaseController {
@OperateInfo(info = LogEnum.SYSTEM_COMMON)
@GetMapping("/getDicDataById")
@ApiOperation("根据字典id查询字典数据")
@ApiImplicitParam(name = "dicIndex", value = "查询参数", required = true)
@ApiImplicitParam(name = "dicIndex", value = "字典id", required = true)
public HttpResult<DictData> getDicDataById(@RequestParam("dicIndex") String dicIndex) {
String methodDescribe = getMethodDescribe("getDicDataById");
DictData result = dictDataService.getDictDataById(dicIndex);
@@ -109,7 +109,7 @@ public class DictDataController extends BaseController {
@OperateInfo(info = LogEnum.SYSTEM_COMMON)
@GetMapping("/getDicDataByCode")
@ApiOperation("根据字典code查询字典数据")
@ApiImplicitParam(name = "code", value = "查询参数", required = true)
@ApiImplicitParam(name = "code", value = "字典code", required = true)
public HttpResult<DictData> getDicDataByCode(@RequestParam("code") String code) {
String methodDescribe = getMethodDescribe("getDicDataByCode");
DictData result = dictDataService.getDictDataByCode(code);

2
system/src/main/java/com/njcn/gather/system/dictionary/controller/DictTreeController.java
View File

@@ -45,7 +45,7 @@ public class DictTreeController extends BaseController {
@OperateInfo(info = LogEnum.SYSTEM_COMMON)
@GetMapping("/getTreeByCode")
@ApiOperation("按照code查询字典树")
@ApiImplicitParam(name = "keyword", value = "查询参数", required = true)
@ApiImplicitParam(name = "code", value = "查询参数", required = true)
public HttpResult<List<DictTree>> getTreeByCode(@RequestParam("code") String code) {
String methodDescribe = getMethodDescribe("getTreeByCode");
LogUtil.njcnDebug(log, "{}，查询数据为：{}", methodDescribe, code);

5
system/src/main/java/com/njcn/gather/system/dictionary/pojo/param/DictTreeParam.java
View File

@@ -34,6 +34,7 @@ public class DictTreeParam {
/**
* 编码
*/
@ApiModelProperty(value = "编码")
@TableField(value = "编码")
@NotBlank(message = SystemValidMessage.CODE_NOT_BLANK)
@Pattern(regexp = PatternRegex.DICT_CODE_REGEX, message = SystemValidMessage.DICT_TYPE_CODE_FORMAT_ERROR)
@@ -42,21 +43,25 @@ public class DictTreeParam {
/**
* 用于区分多种类型的字典树 0.台账对象类型 1.自定义报表指标类型
*/
@ApiModelProperty(value = "0.台账对象类型 1.自定义报表指标类型")
private Integer type;
/**
* 根据type自定义内容，type:0用于区分对象类型是101电网侧 102用户侧
*/
@ApiModelProperty(value = "根据type自定义内容，type:0用于区分对象类型是101电网侧 102用户侧")
private String extend;
/**
* 排序
*/
@ApiModelProperty(value = "排序")
private Integer sort;
/**
* 描述
*/
@ApiModelProperty(value = "描述")
private String remark;

50
system/src/main/java/com/njcn/gather/system/reg/controller/SysRegResController.java
View File

@@ -36,41 +36,41 @@ import java.util.Map;
public class SysRegResController extends BaseController {
private final ISysRegResService sysRegResService;
@OperateInfo(info = LogEnum.SYSTEM_COMMON)
@GetMapping("/list")
@ApiOperation("查询注册版本列表")
public HttpResult<SysRegResVO> listRegRes() {
String methodDescribe = getMethodDescribe("listRegRes");
LogUtil.njcnDebug(log, "{}，查询参数为空", methodDescribe);
SysRegResVO result = sysRegResService.listRegRes();
return HttpResultUtil.assembleCommonResponseResult(CommonResponseEnum.SUCCESS, result, methodDescribe);
}
// @OperateInfo(info = LogEnum.SYSTEM_COMMON)
// @GetMapping("/list")
// @ApiOperation("查询注册版本列表")
// public HttpResult<SysRegResVO> listRegRes() {
// String methodDescribe = getMethodDescribe("listRegRes");
// LogUtil.njcnDebug(log, "{}，查询参数为空", methodDescribe);
// SysRegResVO result = sysRegResService.listRegRes();
// return HttpResultUtil.assembleCommonResponseResult(CommonResponseEnum.SUCCESS, result, methodDescribe);
// }
@OperateInfo(info = LogEnum.SYSTEM_COMMON)
@GetMapping("/getRegResByType")
@ApiOperation("根据类型id查询配置")
@ApiImplicitParam(name = "type", value = "类型id，字典值", required = true)
public HttpResult<SysRegRes> getRegResByType(@RequestParam("id") String typeId) {
@ApiImplicitParam(name = "typeId", value = "类型id，字典值", required = true)
public HttpResult<SysRegRes> getRegResByType(@RequestParam("typeId") String typeId) {
String methodDescribe = getMethodDescribe("listByTypeId");
LogUtil.njcnDebug(log, "{}，查询参数为：{}", methodDescribe, typeId);
SysRegRes result = sysRegResService.getRegResByType(typeId);
return HttpResultUtil.assembleCommonResponseResult(CommonResponseEnum.SUCCESS, result, methodDescribe);
}
@OperateInfo(info = LogEnum.SYSTEM_COMMON, operateType = OperateType.ADD)
@PostMapping("/add")
@ApiOperation("新增注册版本")
@ApiImplicitParam(name = "sysRegRes", value = "注册版本对象", required = true)
public HttpResult<Boolean> addRegRes(@RequestBody @Validated SysRegResParam param) {
String methodDescribe = getMethodDescribe("addRegRes");
LogUtil.njcnDebug(log, "{}，新增参数为：{}", methodDescribe, param);
boolean result = sysRegResService.addRegRes(param);
if (result) {
return HttpResultUtil.assembleCommonResponseResult(CommonResponseEnum.SUCCESS, true, methodDescribe);
} else {
return HttpResultUtil.assembleCommonResponseResult(CommonResponseEnum.FAIL, false, methodDescribe);
}
}
// @OperateInfo(info = LogEnum.SYSTEM_COMMON, operateType = OperateType.ADD)
// @PostMapping("/add")
// @ApiOperation("新增注册版本")
// @ApiImplicitParam(name = "sysRegRes", value = "注册版本对象", required = true)
// public HttpResult<Boolean> addRegRes(@RequestBody @Validated SysRegResParam param) {
// String methodDescribe = getMethodDescribe("addRegRes");
// LogUtil.njcnDebug(log, "{}，新增参数为：{}", methodDescribe, param);
// boolean result = sysRegResService.addRegRes(param);
// if (result) {
// return HttpResultUtil.assembleCommonResponseResult(CommonResponseEnum.SUCCESS, true, methodDescribe);
// } else {
// return HttpResultUtil.assembleCommonResponseResult(CommonResponseEnum.FAIL, false, methodDescribe);
// }
// }
@OperateInfo(info = LogEnum.SYSTEM_COMMON, operateType = OperateType.UPDATE)
@PostMapping("/update")