ZQ/laws-sinotruk-server
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add 国内、海外Swagger注释

Browse Source
This commit is contained in:
liao
2023-11-20 16:04:59 +08:00
parent 2c443dc67e
commit 5e65eaf179
2 changed files with 28 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files
laws-modules/src/main/java/com/jero/modules/laws/standard/controller/LawsDomesticController.java
+14 -14
View File
@@ -74,7 +74,7 @@ public class LawsDomesticController {
@PostMapping(value = "/commonAdd")
@ApiOperationSupport(order = 3)
@RequiresPermissions("domesticStandard:add")
public Result<String> commonAdd(@RequestBody Map<String,Object> parameterMap) {
public Result<String> commonAdd(@RequestBody @ApiParam("标签管理") Map<String,Object> parameterMap) {
parameterMap.put(FieldCommon.MODULE, MODULE_VALUE);
return Result.OK(lawsCommonService.commonAdd(parameterMap));
}
@@ -84,7 +84,7 @@ public class LawsDomesticController {
@PostMapping(value = "/commonEdit")
@ApiOperationSupport(order = 4)
@RequiresPermissions("domesticStandard:edit")
public Result<String> commonEdit(@RequestBody Map<String,Object> parameterMap) {
public Result<String> commonEdit(@RequestBody @ApiParam("标签管理") Map<String,Object> parameterMap) {
parameterMap.put(FieldCommon.MODULE, MODULE_VALUE);
return Result.OK(lawsCommonService.commonEdit(parameterMap));
}
@@ -101,7 +101,7 @@ public class LawsDomesticController {
@ApiOperation(value="国内法规标准-获取表单模型", notes="国内法规标准-获取表单模型")
@GetMapping(value = "getFormModel")
@ApiOperationSupport(order = 6)
public Result<Map<String,Object>> getFormModel(@RequestParam(name="type") String type) {
public Result<Map<String,Object>> getFormModel(@RequestParam(name="type") @ApiParam("类型（1详情，2新增编辑）") String type) {
return Result.OK(lawsCommonService.getFormModel(MODULE_VALUE, type));
}
@@ -110,8 +110,8 @@ public class LawsDomesticController {
@GetMapping(value = "getByIdAndModule")
@ApiOperationSupport(order = 7)
@RequiresPermissions("domesticStandard:search")
public Result<Map<String,Object>> getByIdAndModule(@RequestParam(name="id") String id,
@RequestParam(name="type") String type) {
public Result<Map<String,Object>> getByIdAndModule(@RequestParam(name="id") @ApiParam("主键") String id,
@RequestParam(name="type") @ApiParam("类型（1详情，2新增编辑）") String type) {
lawsCommonService.addLookHistory(id, type, MODULE_VALUE);
return Result.OK(lawsCommonService.getByIdAndModule(id, MODULE_VALUE, type, null));
}
@@ -121,7 +121,7 @@ public class LawsDomesticController {
@PostMapping(value = "deleteByIdsAndModule")
@ApiOperationSupport(order = 8)
@RequiresPermissions("domesticStandard:delete")
public Result<String> deleteByIdsAndModule(@RequestBody Map<String,Object> parameterMap) {
public Result<String> deleteByIdsAndModule(@RequestBody @ApiParam("标签管理") Map<String,Object> parameterMap) {
//删除标准时同步删除这个标准的收藏数据
lawsStandardCollectionService.deleteByStandardId((String) parameterMap.get("ids"));
lawsStandardSharingService.deleteByStandardId((String) parameterMap.get("ids"));
@@ -133,8 +133,8 @@ public class LawsDomesticController {
@GetMapping(value = "relatedStandard")
@ApiOperationSupport(order = 9)
@RequiresPermissions("domesticStandard:configStandard")
public Result<String> relatedStandard(@RequestParam(name="nodeCode") String nodeCode,
@RequestParam("ids") String ids) {
public Result<String> relatedStandard(@RequestParam(name="nodeCode") @ApiParam("体系编码") String nodeCode,
@RequestParam("ids") @ApiParam("主键（多个用逗号分隔）") String ids) {
lawsNodeRelationService.relatedStandard(nodeCode, ids);
return Result.OK(MessageUtils.getMessage(ResultCommon.OK));
}
@@ -144,8 +144,8 @@ public class LawsDomesticController {
@GetMapping(value = "removeStandard")
@ApiOperationSupport(order = 10)
@RequiresPermissions("domesticStandard:removeStandard")
public Result<String> removeStandard(@RequestParam(name="nodeCode") String nodeCode,
@RequestParam("ids") String ids) {
public Result<String> removeStandard(@RequestParam(name="nodeCode") @ApiParam("体系编码") String nodeCode,
@RequestParam("ids") @ApiParam("主键（多个用逗号分隔）") String ids) {
lawsNodeRelationService.removeStandard(nodeCode, ids);
return Result.OK(MessageUtils.getMessage(ResultCommon.OK));
}
@@ -155,7 +155,7 @@ public class LawsDomesticController {
@GetMapping(value = "/getUpdateRecordList")
@ApiOperationSupport(order = 11)
@RequiresPermissions("domesticStandard:updateRecord")
public Result<List<LawsUpdateRecord>> getUpdateRecordList(@RequestParam("standardNumber") String standardNumber) {
public Result<List<LawsUpdateRecord>> getUpdateRecordList(@RequestParam("standardNumber") @ApiParam("标准编号") String standardNumber) {
LambdaQueryWrapper<LawsUpdateRecord> queryWrapper = new LambdaQueryWrapper<>();
queryWrapper.eq(LawsUpdateRecord::getUniqueRelationFlag, standardNumber);
queryWrapper.orderByDesc(LawsUpdateRecord::getCreateTime);
@@ -167,7 +167,7 @@ public class LawsDomesticController {
@PostMapping("/exportData")
@ApiOperationSupport(order = 12)
@RequiresPermissions("domesticStandard:export")
public void exportData(HttpServletResponse response, @RequestBody(required = false) Map<String,Object> parameterMap) {
public void exportData(HttpServletResponse response, @RequestBody(required = false) @ApiParam("标签管理") Map<String,Object> parameterMap) {
parameterMap.put(FieldCommon.MODULE, MODULE_VALUE);
lawsCommonService.commonExport(response, parameterMap, "国内标准", "国内标准");
}
@@ -177,7 +177,7 @@ public class LawsDomesticController {
@PostMapping("/exportDataWithFile")
@ApiOperationSupport(order = 13)
@RequiresPermissions("domesticStandard:exportFile")
public void exportDataWithFile(HttpServletResponse response, @RequestBody(required = false) Map<String,Object> parameterMap) {
public void exportDataWithFile(HttpServletResponse response, @RequestBody(required = false) @ApiParam("标签管理") Map<String,Object> parameterMap) {
parameterMap.put(FieldCommon.MODULE, MODULE_VALUE);
lawsCommonService.exportDataWithFile(response, parameterMap, "国内标准", "国内标准");
}
@@ -196,7 +196,7 @@ public class LawsDomesticController {
@PostMapping("/importExcelWithData")
@ApiOperationSupport(order = 15)
@RequiresPermissions("domesticStandard:import")
public Result<?> importExcelWithData(@RequestParam("file") MultipartFile file) {
public Result<?> importExcelWithData(@RequestParam("file") @ApiParam("文件") MultipartFile file) {
List<String> errorMessages = lawsCommonService.importExcelWithData(file, TableNameEnum.DOMESTIC_REGULATIONS.getValue());
if (errorMessages.size() > 0) {
return Result.error(MessageUtils.getMessage(ResultCommon.IMPORT_ERROR), errorMessages);
laws-modules/src/main/java/com/jero/modules/laws/standard/controller/LawsOverseasController.java
+14 -14
View File
@@ -74,7 +74,7 @@ public class LawsOverseasController {
@PostMapping(value = "/commonAdd")
@ApiOperationSupport(order = 3)
@RequiresPermissions("overseasStandard:add")
public Result<String> commonAdd(@RequestBody Map<String,Object> parameterMap) {
public Result<String> commonAdd(@RequestBody @ApiParam("标签管理") Map<String,Object> parameterMap) {
parameterMap.put(FieldCommon.MODULE, MODULE_VALUE);
return Result.OK(lawsCommonService.commonAdd(parameterMap));
}
@@ -84,7 +84,7 @@ public class LawsOverseasController {
@PostMapping(value = "/commonEdit")
@ApiOperationSupport(order = 4)
@RequiresPermissions("overseasStandard:edit")
public Result<String> commonEdit(@RequestBody Map<String,Object> parameterMap) {
public Result<String> commonEdit(@RequestBody @ApiParam("标签管理") Map<String,Object> parameterMap) {
parameterMap.put(FieldCommon.MODULE, MODULE_VALUE);
return Result.OK(lawsCommonService.commonEdit(parameterMap));
}
@@ -101,7 +101,7 @@ public class LawsOverseasController {
@ApiOperation(value="海外法规标准-获取表单模型", notes="海外法规标准-获取表单模型")
@GetMapping(value = "getFormModel")
@ApiOperationSupport(order = 6)
public Result<Map<String,Object>> getFormModel(@RequestParam(name="type") String type) {
public Result<Map<String,Object>> getFormModel(@RequestParam(name="type") @ApiParam("类型（1详情，2新增编辑）") String type) {
return Result.OK(lawsCommonService.getFormModel(MODULE_VALUE, type));
}
@@ -110,8 +110,8 @@ public class LawsOverseasController {
@GetMapping(value = "getByIdAndModule")
@ApiOperationSupport(order = 7)
@RequiresPermissions("overseasStandard:search")
public Result<Map<String,Object>> getByIdAndModule(@RequestParam(name="id") String id,
@RequestParam(name="type") String type) {
public Result<Map<String,Object>> getByIdAndModule(@RequestParam(name="id") @ApiParam("主键") String id,
@RequestParam(name="type") @ApiParam("类型（1详情，2新增编辑）") String type) {
lawsCommonService.addLookHistory(id, type, MODULE_VALUE);
return Result.OK(lawsCommonService.getByIdAndModule(id, MODULE_VALUE, type, null));
}
@@ -121,7 +121,7 @@ public class LawsOverseasController {
@PostMapping(value = "deleteByIdsAndModule")
@ApiOperationSupport(order = 8)
@RequiresPermissions("overseasStandard:delete")
public Result<String> deleteByIdsAndModule(@RequestBody Map<String,Object> parameterMap) {
public Result<String> deleteByIdsAndModule(@RequestBody @ApiParam("标签管理") Map<String,Object> parameterMap) {
//删除标准时同步删除这个标准的收藏数据
lawsStandardCollectionService.deleteByStandardId((String) parameterMap.get("ids"));
lawsStandardSharingService.deleteByStandardId((String) parameterMap.get("ids"));
@@ -133,8 +133,8 @@ public class LawsOverseasController {
@GetMapping(value = "relatedStandard")
@ApiOperationSupport(order = 9)
@RequiresPermissions("overseasStandard:configStandard")
public Result<String> relatedStandard(@RequestParam(name="nodeCode") String nodeCode,
@RequestParam("ids") String ids) {
public Result<String> relatedStandard(@RequestParam(name="nodeCode") @ApiParam("体系编码") String nodeCode,
@RequestParam("ids") @ApiParam("主键（多个用逗号分隔）") String ids) {
lawsNodeRelationService.relatedStandard(nodeCode, ids);
return Result.OK(MessageUtils.getMessage(ResultCommon.OK));
}
@@ -144,8 +144,8 @@ public class LawsOverseasController {
@GetMapping(value = "removeStandard")
@ApiOperationSupport(order = 10)
@RequiresPermissions("overseasStandard:removeStandard")
public Result<String> removeStandard(@RequestParam(name="nodeCode") String nodeCode,
@RequestParam("ids") String ids) {
public Result<String> removeStandard(@RequestParam(name="nodeCode") @ApiParam("体系编码") String nodeCode,
@RequestParam("ids") @ApiParam("主键（多个用逗号分隔）") String ids) {
lawsNodeRelationService.removeStandard(nodeCode, ids);
return Result.OK(MessageUtils.getMessage(ResultCommon.OK));
}
@@ -155,7 +155,7 @@ public class LawsOverseasController {
@GetMapping(value = "/getUpdateRecordList")
@ApiOperationSupport(order = 11)
@RequiresPermissions("overseasStandard:updateRecord")
public Result<List<LawsUpdateRecord>> getUpdateRecordList(@RequestParam("standardNumber") String standardNumber) {
public Result<List<LawsUpdateRecord>> getUpdateRecordList(@RequestParam("standardNumber") @ApiParam("标准编号") String standardNumber) {
LambdaQueryWrapper<LawsUpdateRecord> queryWrapper = new LambdaQueryWrapper<>();
queryWrapper.eq(LawsUpdateRecord::getUniqueRelationFlag, standardNumber);
queryWrapper.orderByDesc(LawsUpdateRecord::getCreateTime);
@@ -167,7 +167,7 @@ public class LawsOverseasController {
@PostMapping("/exportData")
@ApiOperationSupport(order = 12)
@RequiresPermissions("overseasStandard:export")
public void exportData(HttpServletResponse response, @RequestBody(required = false) Map<String,Object> parameterMap) {
public void exportData(HttpServletResponse response, @RequestBody(required = false) @ApiParam("标签管理") Map<String,Object> parameterMap) {
parameterMap.put(FieldCommon.MODULE, MODULE_VALUE);
lawsCommonService.commonExport(response, parameterMap, "海外标准", "海外标准");
}
@@ -177,7 +177,7 @@ public class LawsOverseasController {
@PostMapping("/exportDataWithFile")
@ApiOperationSupport(order = 13)
@RequiresPermissions("overseasStandard:exportFile")
public void exportDataWithFile(HttpServletResponse response, @RequestBody(required = false) Map<String,Object> parameterMap) {
public void exportDataWithFile(HttpServletResponse response, @RequestBody(required = false) @ApiParam("标签管理") Map<String,Object> parameterMap) {
parameterMap.put(FieldCommon.MODULE, MODULE_VALUE);
lawsCommonService.exportDataWithFile(response, parameterMap, "海外标准", "海外标准");
}
@@ -196,7 +196,7 @@ public class LawsOverseasController {
@PostMapping("/importExcelWithData")
@ApiOperationSupport(order = 15)
@RequiresPermissions("overseasStandard:import")
public Result<?> importExcelWithData(@RequestParam("file") MultipartFile file) {
public Result<?> importExcelWithData(@RequestParam("file") @ApiParam("文件") MultipartFile file) {
List<String> errorMessages = lawsCommonService.importExcelWithData(file, TableNameEnum.FOREIGN_REGULATIONS.getValue());
if (errorMessages.size() > 0) {
return Result.error(ResultCommon.IMPORT_ERROR, errorMessages);