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

docs: 完善文档注释

Browse Source
This commit is contained in:
yjz
2023-11-20 17:39:05 +08:00
parent 23024322e8
commit 8fc59ef979
40 changed files with 932 additions and 227 deletions
Download Patch File Download Diff File Expand all files Collapse all files
laws-modules/src/main/java/com/jero/modules/laws/customcompare/controller/LawsCustomCompareInfoController.java
+24 -21
View File
@@ -3,10 +3,10 @@ package com.jero.modules.laws.customcompare.controller;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.jero.common.api.vo.Result;
import com.jero.common.api.vo.ResultCommon;
import com.jero.common.aspect.annotation.AutoLog;
import com.jero.common.aspect.annotation.Translation;
import com.jero.common.util.MessageUtils;
import com.jero.common.api.vo.ResultCommon;
import com.jero.modules.laws.customcompare.entity.LawsCustomCompareCell;
import com.jero.modules.laws.customcompare.entity.LawsCustomCompareInfo;
import com.jero.modules.laws.customcompare.entity.LawsCustomCompareInventory;
@@ -17,9 +17,12 @@ import com.jero.modules.laws.customcompare.vo.LawsCustomCompareInfoVO;
import com.jero.modules.laws.customcompare.vo.StandardSaveVO;
import com.jero.modules.laws.customcompare.vo.StandardVO;
import com.jero.modules.laws.customcompare.vo.TableDetailVO;
import com.jero.modules.system.vo.IdMapBody;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.apache.poi.ss.formula.functions.T;
import org.apache.shiro.authz.annotation.RequiresPermissions;
import org.springframework.context.annotation.Lazy;
@@ -63,8 +66,8 @@ public class LawsCustomCompareInfoController {
@GetMapping(value = "/queryByPage")
@RequiresPermissions("customComparison:search")
public Result<IPage<LawsCustomCompareInfoVO>> queryByPage(LawsCustomCompareInfoVO lawsCustomCompareInfoVO,
@RequestParam(name="pageNo", defaultValue="1") Integer pageNo,
@RequestParam(name="pageSize", defaultValue="10") Integer pageSize) {
@ApiParam("当前页") @RequestParam(name="pageNo", defaultValue="1") Integer pageNo,
@ApiParam("每页条数") @RequestParam(name="pageSize", defaultValue="10") Integer pageSize) {
return Result.OK(lawsCustomCompareInfoService.queryByPage(lawsCustomCompareInfoVO, pageNo, pageSize));
}
@@ -77,8 +80,8 @@ public class LawsCustomCompareInfoController {
@GetMapping(value = "/queryStandard")
@RequiresPermissions("customComparison:search")
public Result<IPage<StandardVO>> queryStandard(StandardVO standardVO,
@RequestParam(name="pageNo", defaultValue="1") Integer pageNo,
@RequestParam(name="pageSize", defaultValue="10") Integer pageSize) {
@ApiParam("当前页") @RequestParam(name="pageNo", defaultValue="1") Integer pageNo,
@ApiParam("每页条数") @RequestParam(name="pageSize", defaultValue="10") Integer pageSize) {
return Result.OK(lawsCustomCompareInfoService.queryStandard(standardVO, pageNo, pageSize));
}
@@ -102,7 +105,7 @@ public class LawsCustomCompareInfoController {
@ApiOperation(value="自定义对比-删除标准列表", notes="自定义对比-删除标准列表")
@GetMapping(value = "/delStandard")
@RequiresPermissions("customComparison:edit")
public Result<T> delStandard(String infoId, String standardId) {
public Result<T> delStandard(@ApiParam("自定义对比id") String infoId, @ApiParam("标准id") String standardId) {
lawsCustomCompareInfoService.delStandard(infoId, standardId);
return Result.OK(MessageUtils.getMessage(ResultCommon.OK));
}
@@ -115,9 +118,9 @@ public class LawsCustomCompareInfoController {
@ApiOperation(value="自定义对比-标准列表分页查询", notes="自定义对比-标准列表分页查询")
@GetMapping(value = "/queryStandardByInfoId")
@RequiresPermissions("customComparison:search")
public Result<IPage<StandardVO>> queryStandardList(String infoId,
@RequestParam(name="pageNo", defaultValue="1") Integer pageNo,
@RequestParam(name="pageSize", defaultValue="10") Integer pageSize) {
public Result<IPage<StandardVO>> queryStandardList(@ApiParam("自定义对比id") String infoId,
@ApiParam("当前页") @RequestParam(name="pageNo", defaultValue="1") Integer pageNo,
@ApiParam("每页条数") @RequestParam(name="pageSize", defaultValue="10") Integer pageSize) {
return Result.OK(lawsCustomCompareInfoService.queryStandardByInfoId(infoId, pageNo, pageSize));
}
@@ -129,7 +132,7 @@ public class LawsCustomCompareInfoController {
@ApiOperation(value="自定义对比-表格详情", notes="自定义对比-表格详情")
@GetMapping(value = "/queryTableDetail")
@RequiresPermissions("customComparison:search")
public Result<TableDetailVO> queryTableDetail(String infoId) {
public Result<TableDetailVO> queryTableDetail(@ApiParam("自定义对比id") String infoId) {
return Result.OK(lawsCustomCompareInfoService.queryTableDetail(infoId));
}
@@ -141,7 +144,7 @@ public class LawsCustomCompareInfoController {
@ApiOperation(value="自定义对比-清单维护列表查询", notes="自定义对比-清单维护列表查询")
@GetMapping(value = "/queryInventory")
@RequiresPermissions("customComparison:search")
public Result<Map<String, Object>> queryInventoryByInfoId(String infoId) {
public Result<Map<String, Object>> queryInventoryByInfoId(@ApiParam("自定义对比id") String infoId) {
return Result.OK(lawsCustomCompareInfoService.queryInventory(infoId));
}
@@ -153,7 +156,7 @@ public class LawsCustomCompareInfoController {
@ApiOperation(value="自定义对比-清单维护编辑", notes="自定义对比-清单维护编辑")
@PostMapping(value = "/editInventory")
@RequiresPermissions("customComparison:edit")
public Result<T> editInventory(@RequestBody Map<String, Object> map) {
public Result<T> editInventory(@ApiParam("清单维护数据")@RequestBody Map<String, Object> map) {
lawsCustomCompareInfoService.editInventory(map);
return Result.OK(MessageUtils.getMessage(ResultCommon.OK));
}
@@ -207,7 +210,7 @@ public class LawsCustomCompareInfoController {
@GetMapping(value = "/queryById")
@Translation
@RequiresPermissions("customComparison:search")
public Result<LawsCustomCompareInfoVO> queryById(String id) {
public Result<LawsCustomCompareInfoVO> queryById(@ApiParam("id")String id) {
return Result.OK(lawsCustomCompareInfoService.queryById(id));
}
@@ -233,10 +236,10 @@ public class LawsCustomCompareInfoController {
@ApiOperation(value="自定义对比-根据id删除", notes="自定义对比-根据id删除")
@PostMapping(value = "/delById")
@RequiresPermissions("customComparison:delete")
public Result<T> delById(@RequestBody Map<String, Object> map) {
if (map.containsKey("id")){
lawsCustomCompareInfoService.delById((String) map.get("id"));
lawsCustomCompareInfoService.editCompareCreateTime((String) map.get("id"));
public Result<T> delById(@RequestBody IdMapBody map) {
if (StringUtils.isNotBlank(map.getId())){
lawsCustomCompareInfoService.delById(map.getId());
lawsCustomCompareInfoService.editCompareCreateTime(map.getId());
}
return Result.OK(MessageUtils.getMessage(ResultCommon.OK));
}
@@ -249,10 +252,10 @@ public class LawsCustomCompareInfoController {
@ApiOperation(value="自定义对比-根据id删除特点/对比项", notes="自定义对比-根据id删除特点/对比项")
@PostMapping(value = "/delInventoryById")
@RequiresPermissions("customComparison:edit")
public Result<T> delInventoryById(@RequestBody Map<String, Object> map) {
if (map.containsKey("id")){
lawsCustomCompareInventoryService.removeById((String) map.get("id"));
lawsCustomCompareInfoService.editCompareCreateTime((String) map.get("id"));
public Result<T> delInventoryById(@RequestBody IdMapBody map) {
if (StringUtils.isNotBlank(map.getId())){
lawsCustomCompareInventoryService.removeById(map.getId());
lawsCustomCompareInfoService.editCompareCreateTime(map.getId());
}
return Result.OK(MessageUtils.getMessage(ResultCommon.OK));
}