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

5
detection/src/main/java/com/njcn/gather/device/controller/PqDevController.java
View File

@@ -100,7 +100,7 @@ public class PqDevController extends BaseController {
@OperateInfo(operateType = OperateType.DELETE)
@PostMapping("/delete")
@ApiOperation("删除被检设备")
@ApiImplicitParam(name = "ids", value = "被检设备id", required = true)
@ApiImplicitParam(name = "param", value = "删除参数", required = true)
public HttpResult<Boolean> delete(@RequestBody @Validated PqDevParam.DeleteParam param) {
String methodDescribe = getMethodDescribe("delete");
LogUtil.njcnDebug(log, "{}，删除ID数据为：{}", methodDescribe, String.join(StrUtil.COMMA, param.getIds()));
@@ -162,7 +162,8 @@ public class PqDevController extends BaseController {
@OperateInfo
@GetMapping("/getSelectOptions")
@ApiOperation("根据历史记录信息来获取下拉框内容")
@ApiOperation("从历史数据中查询下拉框选项")
@ApiImplicitParam(name = "pattern", value = "模式id", required = true)
public HttpResult<Map<String, List<String>>> getSelectOptions(@RequestParam("pattern") String pattern) {
String methodDescribe = getMethodDescribe("getSelectOptions");
Map<String, List<String>> result = pqDevService.listSelectOptions(pattern);

22
detection/src/main/java/com/njcn/gather/device/controller/PqStandardDevController.java
View File

@@ -149,17 +149,17 @@ public class PqStandardDevController extends BaseController {
return HttpResultUtil.assembleCommonResponseResult(CommonResponseEnum.SUCCESS, result, methodDescribe);
}
@OperateInfo(info = LogEnum.BUSINESS_COMMON)
@PostMapping("/listByPlanId")
@ApiOperation("查询出指定计划已关联的标准设备")
@ApiImplicitParam(name = "planId", value = "计划id", required = true)
public HttpResult<List<PqStandardDev>> listByPlanId(@RequestParam("planId") String planId) {
String methodDescribe = getMethodDescribe("listByPlanId");
LogUtil.njcnDebug(log, "{}，查询数据为：{}", methodDescribe, planId);
List<PqStandardDev> pqDevVOList = pqStandardDevService.listByPlanId(planId);
return HttpResultUtil.assembleCommonResponseResult(CommonResponseEnum.SUCCESS, pqDevVOList, methodDescribe);
}
// @OperateInfo(info = LogEnum.BUSINESS_COMMON)
// @PostMapping("/listByPlanId")
// @ApiOperation("查询出指定计划已关联的标准设备")
// @ApiImplicitParam(name = "planId", value = "计划id", required = true)
// public HttpResult<List<PqStandardDev>> listByPlanId(@RequestParam("planId") String planId) {
// String methodDescribe = getMethodDescribe("listByPlanId");
// LogUtil.njcnDebug(log, "{}，查询数据为：{}", methodDescribe, planId);
// List<PqStandardDev> pqDevVOList = pqStandardDevService.listByPlanId(planId);
//
// return HttpResultUtil.assembleCommonResponseResult(CommonResponseEnum.SUCCESS, pqDevVOList, methodDescribe);
// }
@OperateInfo(info = LogEnum.BUSINESS_COMMON)

2
detection/src/main/java/com/njcn/gather/device/service/IPqStandardDevService.java
View File

@@ -82,7 +82,7 @@ public interface IPqStandardDevService extends IService<PqStandardDev> {
* @param planId
* @return
*/
List<PqStandardDev> listByPlanId(String planId);
// List<PqStandardDev> listByPlanId(String planId);
/**
* 查询出标准设备所需的检测信息

8
detection/src/main/java/com/njcn/gather/device/service/impl/PqStandardDevServiceImpl.java
View File

@@ -154,10 +154,10 @@ public class PqStandardDevServiceImpl extends ServiceImpl<PqStandardDevMapper, P
this.importData(contrastDevExcelList);
}
@Override
public List<PqStandardDev> listByPlanId(String planId) {
return adPlanStandardDevMapper.listByPlanId(Collections.singletonList(planId));
}
// @Override
// public List<PqStandardDev> listByPlanId(String planId) {
// return adPlanStandardDevMapper.listByPlanId(Collections.singletonList(planId));
// }
@Override
public List<PreDetection> listStandardDevPreDetection(List<String> ids) {

8
detection/src/main/java/com/njcn/gather/plan/controller/AdPlanController.java
View File

@@ -180,7 +180,7 @@ public class AdPlanController extends BaseController {
@OperateInfo(info = LogEnum.BUSINESS_COMMON)
@PostMapping("/getBigTestItem")
@ApiOperation("获取检测大项数据")
@ApiImplicitParam(name = "id", value = "检测计划id", required = true)
@ApiImplicitParam(name = "checkParam", value = "检测计划id", required = true)
public HttpResult<List<Map<String, String>>> getBigTestItem(@RequestBody AdPlanParam.CheckParam checkParam) {
String methodDescribe = getMethodDescribe("getBigTestItem");
LogUtil.njcnDebug(log, "{}，查询数据为：{}", methodDescribe, checkParam);
@@ -191,7 +191,7 @@ public class AdPlanController extends BaseController {
@OperateInfo(info = LogEnum.BUSINESS_COMMON, operateType = OperateType.DOWNLOAD)
@PostMapping("/analyse")
@ApiOperation("检测数据分析")
@ApiImplicitParam(name = "planId", value = "检测计划id", required = true)
@ApiImplicitParam(name = "ids", value = "检测计划id", required = true)
public void analyse(@RequestBody List<String> ids) {
String methodDescribe = getMethodDescribe("analyse");
LogUtil.njcnDebug(log, "{}，查询数据为：{}", methodDescribe, String.join(StrUtil.COMMA, ids));
@@ -201,7 +201,7 @@ public class AdPlanController extends BaseController {
@OperateInfo(info = LogEnum.BUSINESS_COMMON)
@PostMapping("/listByPlanId")
@ApiOperation("查询出所有已绑定的设备")
@ApiImplicitParam(name = "planId", value = "计划id", required = true)
@ApiImplicitParam(name = "param", value = "查询参数", required = true)
public HttpResult<List<PqDevVO>> listByPlanId(@RequestBody @Validated PqDevParam.QueryParam param) {
String methodDescribe = getMethodDescribe("listByPlanId");
LogUtil.njcnDebug(log, "{}，查询数据为：{}", methodDescribe, param);
@@ -241,7 +241,7 @@ public class AdPlanController extends BaseController {
@OperateInfo(info = LogEnum.BUSINESS_COMMON)
@PostMapping("/listDevByPlanId")
@ApiOperation("根据计划id分页查询被检设备")
@ApiImplicitParam(name = "queryParam", value = "查询参数", required = true)
@ApiImplicitParam(name = "param", value = "查询参数", required = true)
public HttpResult<Page<PqDevVO>> listDevByPlanId(@RequestBody @Validated PqDevParam.QueryParam param) {
String methodDescribe = getMethodDescribe("listDevByPlanId");
LogUtil.njcnDebug(log, "{}，查询数据为：{}", methodDescribe, param);

13
detection/src/main/java/com/njcn/gather/report/controller/ReportController.java
View File

@@ -31,7 +31,7 @@ import java.util.List;
* @data 2025/1/9 14:02
*/
@Slf4j
@Api(tags = "报表管理")
@Api(tags = "报告管理")
@RestController
@RequestMapping("/report")
@RequiredArgsConstructor
@@ -46,7 +46,7 @@ public class ReportController extends BaseController {
*/
@OperateInfo
@PostMapping("/generateReport")
@ApiOperation("生成测试报告")
@ApiOperation("生成报告")
@ApiImplicitParam(name = "param", value = "查询参数", required = true)
public HttpResult<Object> generateReport(@RequestBody DevReportParam devReportParam) {
String methodDescribe = getMethodDescribe("generateReport");
@@ -60,7 +60,7 @@ public class ReportController extends BaseController {
*/
@OperateInfo
@PostMapping("/downloadReport")
@ApiOperation("下载测试报告")
@ApiOperation("下载报告")
@ApiImplicitParam(name = "param", value = "查询参数", required = true)
public void downloadReport(@RequestBody DevReportParam devReportParam, HttpServletResponse response) {
String methodDescribe = getMethodDescribe("downloadReport");
@@ -91,7 +91,7 @@ public class ReportController extends BaseController {
@OperateInfo(operateType = OperateType.ADD)
@PostMapping("/add")
@ApiOperation("新增报告模板")
@ApiImplicitParam(name = "param", value = "报告模板参数", required = true)
@ApiImplicitParam(name = "reportParam", value = "报告模板参数", required = true)
public HttpResult<Boolean> add(ReportParam reportParam) {
String methodDescribe = getMethodDescribe("add");
LogUtil.njcnDebug(log, "{}，新增参数为：{}", methodDescribe, reportParam);
@@ -106,7 +106,7 @@ public class ReportController extends BaseController {
@OperateInfo(operateType = OperateType.UPDATE)
@PostMapping("/update")
@ApiOperation("更新报告模板")
@ApiImplicitParam(name = "param", value = "报告模板参数", required = true)
@ApiImplicitParam(name = "reportParam", value = "报告模板参数", required = true)
public HttpResult<Boolean> update(ReportParam.UpdateParam reportParam) {
String methodDescribe = getMethodDescribe("update");
LogUtil.njcnDebug(log, "{}，修改参数为：{}", methodDescribe, reportParam);
@@ -136,7 +136,6 @@ public class ReportController extends BaseController {
@OperateInfo
@GetMapping("/listAllName")
@ApiOperation("查询所有报告模板名称")
@ApiImplicitParam(name = "param", value = "查询参数", required = true)
public HttpResult<List<String>> listAllName() {
String methodDescribe = getMethodDescribe("listAllName");
return HttpResultUtil.assembleCommonResponseResult(CommonResponseEnum.SUCCESS, pqReportService.listAllName(), methodDescribe);
@@ -145,7 +144,7 @@ public class ReportController extends BaseController {
@OperateInfo(info = LogEnum.BUSINESS_COMMON, operateType = OperateType.UPDATE)
@PostMapping("/documented")
@ApiOperation("设备归档")
@ApiImplicitParam(name = "id", value = "设备id", required = true)
@ApiImplicitParam(name = "ids", value = "设备id", required = true)
public HttpResult<Boolean> documented(@RequestBody List<String> ids) {
String methodDescribe = getMethodDescribe("documented");
LogUtil.njcnDebug(log, "{}，设备id为：{}", methodDescribe, ids);

12
detection/src/main/java/com/njcn/gather/result/controller/ResultController.java
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);

3
detection/src/main/java/com/njcn/gather/result/pojo/param/ResultParam.java
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)

40
detection/src/main/java/com/njcn/gather/result/pojo/vo/MonitorResultVO.java
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;

4
detection/src/main/java/com/njcn/gather/script/controller/PqScriptController.java
View File

@@ -58,7 +58,7 @@ public class PqScriptController extends BaseController {
@OperateInfo(operateType = OperateType.ADD)
@PostMapping("/add")
@ApiOperation("新增检测脚本")
@ApiImplicitParam(name = "pqDevParam", value = "检测脚本", required = true)
@ApiImplicitParam(name = "param", value = "检测脚本", required = true)
public HttpResult<String> add(@RequestBody @Validated PqScriptParam param) {
String methodDescribe = getMethodDescribe("add");
LogUtil.njcnDebug(log, "{}，新增数据为：{}", methodDescribe, param);
@@ -69,7 +69,7 @@ public class PqScriptController extends BaseController {
@OperateInfo(operateType = OperateType.UPDATE)
@PostMapping("/update")
@ApiOperation("修改检测脚本")
@ApiImplicitParam(name = "updateParam", value = "检测脚本", required = true)
@ApiImplicitParam(name = "param", value = "检测脚本", required = true)
public HttpResult<Boolean> update(@RequestBody @Validated PqScriptParam.UpdateParam param) {
String methodDescribe = getMethodDescribe("update");
LogUtil.njcnDebug(log, "{}，修改数据为：{}", methodDescribe, param);

12
detection/src/main/java/com/njcn/gather/source/controller/PqSourceController.java
View File

@@ -127,17 +127,5 @@ public class PqSourceController extends BaseController {
List<SourceParam> result = pqSourceService.getSourceParam(sourceId);
return HttpResultUtil.assembleCommonResponseResult(CommonResponseEnum.SUCCESS, result, methodDescribe);
}
@OperateInfo
@GetMapping("/aa")
@ApiOperation("按照检测源ID获取源参数")
@ApiImplicitParam(name = "pqSourceId", value = "检测源ID", required = true)
public HttpResult<SourceInitialize> aa(@RequestParam("sourceId") String sourceId) {
String methodDescribe = getMethodDescribe("getParam");
LogUtil.njcnDebug(log, "{}，查询数据为：{}", methodDescribe, sourceId);
SourceInitialize sourceInitializeParam = pqSourceService.getSourceInitializeParam(sourceId);
String jsonString = JSON.toJSONString(sourceInitializeParam);
return HttpResultUtil.assembleCommonResponseResult(CommonResponseEnum.SUCCESS, sourceInitializeParam, methodDescribe);
}
}

2
detection/src/main/java/com/njcn/gather/type/controller/DevTypeController.java
View File

@@ -81,7 +81,7 @@ public class DevTypeController extends BaseController {
@OperateInfo(info = LogEnum.BUSINESS_COMMON, operateType = OperateType.UPDATE)
@PostMapping("/update")
@ApiOperation("修改设备类型")
@ApiImplicitParam(name = "devTypeParam", value = "设备类型", required = true)
@ApiImplicitParam(name = "updateParam", value = "设备类型参数", required = true)
public HttpResult<Boolean> update(@RequestBody @Validated DevTypeParam.UpdateParam updateParam) {
String methodDescribe = getMethodDescribe("update");
LogUtil.njcnDebug(log, "{}，修改数据为：{}", methodDescribe, updateParam);