调整接口注释

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

View File

@@ -90,7 +90,7 @@ public class ResultController extends BaseController {
@OperateInfo(info = LogEnum.BUSINESS_COMMON, operateType = OperateType.UPDATE)
@PostMapping("/reCalculate")
@ApiOperation("重新计算检测结果")
@ApiImplicitParam(name = "queryParam", value = "查询参数", required = true)
@ApiImplicitParam(name = "param", value = "重新计算参数", required = true)
public HttpResult<Object> reCalculate(@RequestBody @Validated ResultParam.ChangeErrorSystemParam param) {
String methodDescribe = getMethodDescribe("reCalculate");
LogUtil.njcnDebug(log, "{},查询数据为:{}", methodDescribe, param);
@@ -115,7 +115,7 @@ public class ResultController extends BaseController {
@OperateInfo(info = LogEnum.BUSINESS_COMMON, operateType = OperateType.DELETE)
@GetMapping("/deleteTempTable")
@ApiOperation("删除临时表")
@ApiImplicitParam(name = "param", value = "删除参数", required = true)
@ApiImplicitParam(name = "code", value = "计划对应的表后缀code", required = true)
public HttpResult<Object> deleteTempTable(@RequestParam("code") String code) {
String methodDescribe = getMethodDescribe("deleteTempTable");
LogUtil.njcnDebug(log, "{},查询数据为:{}", methodDescribe, code);
@@ -127,7 +127,7 @@ public class ResultController extends BaseController {
@OperateInfo(info = LogEnum.BUSINESS_COMMON)
@PostMapping("/getContrastFormContent")
@ApiOperation("获取比对式检测结果-表单内容")
@ApiImplicitParam(name = "param", value = "查询参数", required = true)
@ApiImplicitParam(name = "queryParam", value = "查询参数", required = true)
public HttpResult<FormContentVO> getContrastFormContent(@RequestBody @Validated ResultParam.QueryParam queryParam) {
String methodDescribe = getMethodDescribe("getContrastFormContent");
LogUtil.njcnDebug(log, "{},查询数据为:{}", methodDescribe, queryParam);
@@ -139,7 +139,7 @@ public class ResultController extends BaseController {
@OperateInfo(info = LogEnum.BUSINESS_COMMON)
@PostMapping("/getContrastResult")
@ApiOperation("获取比对式检测结果")
@ApiImplicitParam(name = "param", value = "查询参数", required = true)
@ApiImplicitParam(name = "queryParam", value = "查询参数", required = true)
public HttpResult<ContrastResultVO> getContrastResult(@RequestBody @Validated ResultParam.QueryParam queryParam) {
String methodDescribe = getMethodDescribe("getContrastResult");
LogUtil.njcnDebug(log, "{},查询数据为:{}", methodDescribe, queryParam);
@@ -154,7 +154,7 @@ public class ResultController extends BaseController {
@OperateInfo(info = LogEnum.BUSINESS_COMMON)
@PostMapping("/getMonitorResult")
@ApiOperation("获取监测点的检测结果")
@ApiImplicitParam(name = "param", value = "查询参数", required = true)
@ApiImplicitParam(name = "devId", value = "设备id", required = true)
public HttpResult<List<MonitorResultVO>> getMonitorResult(@RequestParam("devId") String devId) {
String methodDescribe = getMethodDescribe("getMonitorResult");
LogUtil.njcnDebug(log, "{},查询数据为:{}", methodDescribe, devId);
@@ -180,7 +180,7 @@ public class ResultController extends BaseController {
@OperateInfo(info = LogEnum.BUSINESS_COMMON)
@PostMapping("/updateMonitorResult")
@ApiOperation("更新监测点的检测结果")
@ApiImplicitParam(name = "result", value = "更新内容", required = true)
@ApiImplicitParam(name = "resultParams", value = "更新内容", required = true)
public HttpResult<Boolean> updateMonitorResult(@RequestBody @Validated MonitorResultVO resultParams) {
String methodDescribe = getMethodDescribe("updateMonitorResult");
LogUtil.njcnDebug(log, "{},更新数据为:{}", methodDescribe, resultParams);

View File

@@ -83,7 +83,7 @@ public class ResultParam {
@Pattern(regexp = PatternRegex.SYSTEM_ID, message = DetectionValidMessage.PLAN_ID_FORMAT_ERROR)
private String planId;
@ApiModelProperty(value = "脚本Id", required = false)
@ApiModelProperty(value = "脚本Id")
private String scriptId;
@ApiModelProperty(value = "误差体系Id", required = true)
@@ -95,6 +95,7 @@ public class ResultParam {
@Pattern(regexp = PatternRegex.SYSTEM_ID, message = DetectionValidMessage.DEV_ID_FORMAT_ERROR)
private String deviceId;
@ApiModelProperty(value = "计划对应表后缀", required = true)
private String code;
@ApiModelProperty(value = "模式Id", required = true)

View File

@@ -14,58 +14,38 @@ import javax.validation.constraints.NotNull;
@Data
public class MonitorResultVO implements Comparable<MonitorResultVO> {
/**
* 监测点id
*/
@ApiModelProperty(value = "监测点id", required = true)
@NotBlank(message = DetectionValidMessage.DEV_MONITOR_ID_NOT_BLANK)
private String monitorId;
/**
* 监测点序号
*/
@ApiModelProperty(value = "监测点序号")
private Integer monitorNum;
/**
* 总检测次数
*/
@ApiModelProperty(value = "总检测次数")
private Integer totalNum;
/**
* 合格检测次数
*/
@ApiModelProperty(value = "合格检测次数")
private Integer qualifiedNum;
/**
* 不合格检测次数
*/
@ApiModelProperty(value = "不合格检测次数")
private Integer unQualifiedNum;
/**
* 误差体系名称
*/
@ApiModelProperty(value = "误差体系名称")
private String errorSysName;
/**
* 检测结果
*/
@ApiModelProperty(value = "检测结果", required = true)
@NotNull(message = DetectionValidMessage.DEV_MONITOR_RESULT_NOT_NULL)
private Integer checkResult;
/**
* 结论来源
*/
@ApiModelProperty(value = "结论来源")
private String resultOrigin;
/**
* 哪次
*/
@ApiModelProperty(value = "使用哪次检测结果", required = true)
@NotNull(message = DetectionValidMessage.DEV_MONITOR_RESULT_NUM_NOT_BLANK)
private String whichTime;
/**
* 数据源类型
*/
@ApiModelProperty(value = "数据源类型", required = true)
@NotBlank(message = DetectionValidMessage.DEV_MONITOR_RESULT_TYPE_NOT_BLANK)
private String resultType;