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/standardization/controller/LawsStandardizationController.java
+12 -11
View File
@@ -1,16 +1,18 @@
package com.jero.modules.laws.standardization.controller;
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.system.base.controller.JeroController;
import com.jero.common.util.MessageUtils;
import com.jero.common.api.vo.ResultCommon;
import com.jero.modules.laws.standardization.entity.*;
import com.jero.modules.laws.standardization.service.ILawsStandardizationService;
import com.jero.modules.laws.standardization.vo.StandardizationVO;
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;
@@ -19,7 +21,6 @@ import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;
import java.util.List;
import java.util.Map;
/**
@@ -99,7 +100,7 @@ public class LawsStandardizationController extends JeroController<LawsStandardiz
@AutoLog(value = "标准化活动-通过id查询")
@ApiOperation(value="标准化活动-通过id查询", notes="标准化活动-通过id查询")
@GetMapping(value = "/queryById")
public Result<LawsStandardization> queryById(@RequestParam(name="id",required=true) String id) {
public Result<LawsStandardization> queryById(@ApiParam("id") @RequestParam(name="id",required=true) String id) {
return Result.OK(lawsStandardizationService.queryById(id));
}
@@ -112,7 +113,7 @@ public class LawsStandardizationController extends JeroController<LawsStandardiz
@AutoLog(value = "标准化活动-会议统计-联络人联系方式")
@ApiOperation(value="标准化活动-会议统计-联络人联系方式", notes="标准化活动-会议统计-联络人联系方式")
@GetMapping(value = "/queryLiaisonByStandardizationId")
public Result<List<LawsStandardizationLiaison>> queryLiaisonByStandardizationId(@RequestParam(name="id",required=true) String standardizationId) {
public Result<List<LawsStandardizationLiaison>> queryLiaisonByStandardizationId(@ApiParam("标准化活动id") @RequestParam(name="id",required=true) String standardizationId) {
return Result.OK(lawsStandardizationService.queryLiaisonByStandardizationId(standardizationId));
}
@@ -125,7 +126,7 @@ public class LawsStandardizationController extends JeroController<LawsStandardiz
@AutoLog(value = "标准化活动-会议统计-集团参与情况")
@ApiOperation(value="标准化活动-会议统计-集团参与情况", notes="标准化活动-会议统计-集团参与情况")
@GetMapping(value = "/queryGroupByStandardizationId")
public Result<List<LawsStandardizationGroup>> queryGroupByStandardizationId(@RequestParam(name="id",required=true) String standardizationId) {
public Result<List<LawsStandardizationGroup>> queryGroupByStandardizationId(@ApiParam("标准化活动id") @RequestParam(name="id",required=true) String standardizationId) {
return Result.OK(lawsStandardizationService.queryGroupByStandardizationId(standardizationId));
}
@@ -139,7 +140,7 @@ public class LawsStandardizationController extends JeroController<LawsStandardiz
@ApiOperation(value="标准化活动-会议统计-支付信息", notes="标准化活动-会议统计-支付信息")
@GetMapping(value = "/queryPaymentByStandardizationId")
@Translation
public Result<List<LawsStandardizationPayment>> queryPaymentByStandardizationId(@RequestParam(name="id",required=true) String standardizationId) {
public Result<List<LawsStandardizationPayment>> queryPaymentByStandardizationId(@ApiParam("标准化活动id") @RequestParam(name="id",required=true) String standardizationId) {
return Result.OK(lawsStandardizationService.queryPaymentByStandardizationId(standardizationId));
}
@@ -152,7 +153,7 @@ public class LawsStandardizationController extends JeroController<LawsStandardiz
@AutoLog(value = "标准化活动-会议统计-参会记录")
@ApiOperation(value="标准化活动-会议统计-参会记录", notes="标准化活动-会议统计-参会记录")
@GetMapping(value = "/queryMeetingByStandardizationId")
public Result<List<LawsStandardizationMeeting>> queryMeetingByStandardizationId(@RequestParam(name="id",required=true) String standardizationId) {
public Result<List<LawsStandardizationMeeting>> queryMeetingByStandardizationId(@ApiParam("标准化活动id") @RequestParam(name="id",required=true) String standardizationId) {
return Result.OK(lawsStandardizationService.queryMeetingByStandardizationId(standardizationId));
}
@@ -164,7 +165,7 @@ public class LawsStandardizationController extends JeroController<LawsStandardiz
@ApiOperation(value="标准化活动-详情通过id查询", notes="标准化活动-详情通过id查询")
@GetMapping(value = "/queryDetailById")
@Translation
public Result<StandardizationVO> queryDetailById(String id) {
public Result<StandardizationVO> queryDetailById(@ApiParam("id") String id) {
return Result.OK(lawsStandardizationService.queryDetailById(id));
}
@@ -177,11 +178,11 @@ public class LawsStandardizationController extends JeroController<LawsStandardiz
@AutoLog(value = "标准化活动-通过id删除")
@ApiOperation(value="标准化活动-通过id删除", notes="标准化活动-通过id删除")
@PostMapping(value = "/delete")
public Result<T> delete(@RequestBody Map<String, String> map) {
if(!map.containsKey("id") || StringUtils.isEmpty(map.get("id"))){
public Result<T> delete(@RequestBody IdMapBody map) {
if (StringUtils.isBlank(map.getId())){
return Result.error("请选择数据!");
}
lawsStandardizationService.delete(map.get("id"));
lawsStandardizationService.delete(map.getId());
return Result.OK("删除成功!");
}
}
laws-modules/src/main/java/com/jero/modules/laws/standardization/controller/LawsStandardizationGroupController.java
+12 -10
View File
@@ -6,8 +6,11 @@ import com.jero.common.aspect.annotation.AutoLog;
import com.jero.common.system.base.controller.JeroController;
import com.jero.modules.laws.standardization.entity.LawsStandardizationGroup;
import com.jero.modules.laws.standardization.service.ILawsStandardizationGroupService;
import com.jero.modules.system.vo.IdMapBody;
import com.jero.modules.system.vo.IdsMapBody;
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;
@@ -20,7 +23,6 @@ import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
/**
@@ -50,8 +52,8 @@ public class LawsStandardizationGroupController extends JeroController<LawsStand
@ApiOperation(value="标准化-集团参与情况-分页列表查询", notes="标准化-集团参与情况-分页列表查询")
@GetMapping(value = "/page")
public Result<IPage<LawsStandardizationGroup>> queryPageList(LawsStandardizationGroup lawsStandardizationGroup,
@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,
HttpServletRequest req) {
IPage<LawsStandardizationGroup> pageList = lawsStandardizationGroupService.queryPage(lawsStandardizationGroup, pageNo, pageSize, req);
return Result.OK(pageList);
@@ -109,11 +111,11 @@ public class LawsStandardizationGroupController extends JeroController<LawsStand
@AutoLog(value = "标准化-集团参与情况-通过id删除")
@ApiOperation(value="标准化-集团参与情况-通过id删除", notes="标准化-集团参与情况-通过id删除")
@PostMapping(value = "/delete")
public Result<T> delete(@RequestBody Map<String, String> map) {
if(!map.containsKey("id") || StringUtils.isEmpty(map.get("id"))){
public Result<T> delete(@RequestBody IdMapBody map) {
if (StringUtils.isBlank(map.getId())){
return Result.error("请选择数据!");
}
lawsStandardizationGroupService.deleteById(map.get("id"));
lawsStandardizationGroupService.deleteById(map.getId());
return Result.OK("删除成功!");
}
@@ -126,11 +128,11 @@ public class LawsStandardizationGroupController extends JeroController<LawsStand
@AutoLog(value = "标准化-集团参与情况-批量删除")
@ApiOperation(value="标准化-集团参与情况-批量删除", notes="标准化-集团参与情况-批量删除")
@PostMapping(value = "/deleteBatch")
public Result<T> deleteBatch(@RequestBody Map<String, String> map) {
if(!map.containsKey("ids") || StringUtils.isEmpty(map.get("ids"))){
public Result<T> deleteBatch(@RequestBody IdsMapBody map) {
if (StringUtils.isBlank(map.getIds())){
return Result.error("请选择数据!");
}
this.lawsStandardizationGroupService.deleteByIds(Arrays.asList(map.get("ids").split(",")));
this.lawsStandardizationGroupService.deleteByIds(Arrays.asList(map.getIds().split(",")));
return Result.OK("批量删除成功!");
}
@@ -143,7 +145,7 @@ public class LawsStandardizationGroupController extends JeroController<LawsStand
@AutoLog(value = "标准化-集团参与情况-通过id查询")
@ApiOperation(value="标准化-集团参与情况-通过id查询", notes="标准化-集团参与情况-通过id查询")
@GetMapping(value = "/queryById")
public Result<LawsStandardizationGroup> queryById(@RequestParam(name="id",required=true) String id) {
public Result<LawsStandardizationGroup> queryById(@ApiParam("id") @RequestParam(name="id",required=true) String id) {
LawsStandardizationGroup lawsStandardizationGroup = lawsStandardizationGroupService.queryById(id);
if(lawsStandardizationGroup==null) {
return Result.error("未找到对应数据");
laws-modules/src/main/java/com/jero/modules/laws/standardization/controller/LawsStandardizationLiaisonController.java
+14 -12
View File
@@ -6,8 +6,11 @@ import com.jero.common.aspect.annotation.AutoLog;
import com.jero.common.system.base.controller.JeroController;
import com.jero.modules.laws.standardization.entity.LawsStandardizationLiaison;
import com.jero.modules.laws.standardization.service.ILawsStandardizationLiaisonService;
import com.jero.modules.system.vo.IdMapBody;
import com.jero.modules.system.vo.IdsMapBody;
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;
@@ -20,7 +23,6 @@ import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
/**
@@ -50,8 +52,8 @@ public class LawsStandardizationLiaisonController extends JeroController<LawsSta
@ApiOperation(value="标准化-联络人-分页列表查询", notes="标准化-联络人-分页列表查询")
@GetMapping(value = "/page")
public Result<IPage<LawsStandardizationLiaison>> queryPageList(LawsStandardizationLiaison lawsStandardizationLiaison,
@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,
HttpServletRequest req) {
IPage<LawsStandardizationLiaison> pageList = lawsStandardizationLiaisonService.queryPage(lawsStandardizationLiaison, pageNo, pageSize, req);
return Result.OK(pageList);
@@ -109,11 +111,11 @@ public class LawsStandardizationLiaisonController extends JeroController<LawsSta
@AutoLog(value = "标准化-联络人-通过id删除")
@ApiOperation(value="标准化-联络人-通过id删除", notes="标准化-联络人-通过id删除")
@PostMapping(value = "/delete")
public Result<T> delete(@RequestBody Map<String, String> map) {
if(!map.containsKey("id") || StringUtils.isEmpty(map.get("id"))){
return Result.error("请选择数据!");
}
lawsStandardizationLiaisonService.deleteById(map.get("id"));
public Result<T> delete(@RequestBody IdMapBody map) {
if (StringUtils.isBlank(map.getId())){
return Result.error("请选择数据!");
}
lawsStandardizationLiaisonService.deleteById(map.getId());
return Result.OK("删除成功!");
}
@@ -126,11 +128,11 @@ public class LawsStandardizationLiaisonController extends JeroController<LawsSta
@AutoLog(value = "标准化-联络人-批量删除")
@ApiOperation(value="标准化-联络人-批量删除", notes="标准化-联络人-批量删除")
@PostMapping(value = "/deleteBatch")
public Result<T> deleteBatch(@RequestBody Map<String, String> map) {
if(!map.containsKey("ids") || StringUtils.isEmpty(map.get("ids"))){
public Result<T> deleteBatch(@RequestBody IdsMapBody map) {
if (StringUtils.isBlank(map.getIds())){
return Result.error("请选择数据!");
}
this.lawsStandardizationLiaisonService.deleteByIds(Arrays.asList(map.get("ids").split(",")));
this.lawsStandardizationLiaisonService.deleteByIds(Arrays.asList(map.getIds().split(",")));
return Result.OK("批量删除成功!");
}
@@ -143,7 +145,7 @@ public class LawsStandardizationLiaisonController extends JeroController<LawsSta
@AutoLog(value = "标准化-联络人-通过id查询")
@ApiOperation(value="标准化-联络人-通过id查询", notes="标准化-联络人-通过id查询")
@GetMapping(value = "/queryById")
public Result<LawsStandardizationLiaison> queryById(@RequestParam(name="id",required=true) String id) {
public Result<LawsStandardizationLiaison> queryById(@ApiParam("id") @RequestParam(name="id",required=true) String id) {
LawsStandardizationLiaison lawsStandardizationLiaison = lawsStandardizationLiaisonService.queryById(id);
if(lawsStandardizationLiaison==null) {
return Result.error("未找到对应数据");
laws-modules/src/main/java/com/jero/modules/laws/standardization/controller/LawsStandardizationMeetingController.java
+14 -12
View File
@@ -6,8 +6,11 @@ import com.jero.common.aspect.annotation.AutoLog;
import com.jero.common.system.base.controller.JeroController;
import com.jero.modules.laws.standardization.entity.LawsStandardizationMeeting;
import com.jero.modules.laws.standardization.service.ILawsStandardizationMeetingService;
import com.jero.modules.system.vo.IdMapBody;
import com.jero.modules.system.vo.IdsMapBody;
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;
@@ -20,7 +23,6 @@ import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
/**
@@ -50,8 +52,8 @@ public class LawsStandardizationMeetingController extends JeroController<LawsSta
@ApiOperation(value="标准化-参会记录-分页列表查询", notes="标准化-参会记录-分页列表查询")
@GetMapping(value = "/page")
public Result<IPage<LawsStandardizationMeeting>> queryPageList(LawsStandardizationMeeting lawsStandardizationMeeting,
@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,
HttpServletRequest req) {
IPage<LawsStandardizationMeeting> pageList = lawsStandardizationMeetingService.queryPage(lawsStandardizationMeeting, pageNo, pageSize, req);
return Result.OK(pageList);
@@ -109,11 +111,11 @@ public class LawsStandardizationMeetingController extends JeroController<LawsSta
@AutoLog(value = "标准化-参会记录-通过id删除")
@ApiOperation(value="标准化-参会记录-通过id删除", notes="标准化-参会记录-通过id删除")
@PostMapping(value = "/delete")
public Result<T> delete(@RequestBody Map<String, String> map) {
if(!map.containsKey("id") || StringUtils.isEmpty(map.get("id"))){
return Result.error("请选择数据!");
}
lawsStandardizationMeetingService.deleteById(map.get("id"));
public Result<T> delete(@RequestBody IdMapBody map) {
if (StringUtils.isBlank(map.getId())){
return Result.error("请选择数据!");
}
lawsStandardizationMeetingService.deleteById(map.getId());
return Result.OK("删除成功!");
}
@@ -126,11 +128,11 @@ public class LawsStandardizationMeetingController extends JeroController<LawsSta
@AutoLog(value = "标准化-参会记录-批量删除")
@ApiOperation(value="标准化-参会记录-批量删除", notes="标准化-参会记录-批量删除")
@PostMapping(value = "/deleteBatch")
public Result<T> deleteBatch(@RequestBody Map<String, String> map) {
if(!map.containsKey("ids") || StringUtils.isEmpty(map.get("ids"))){
public Result<T> deleteBatch(@RequestBody IdsMapBody map) {
if (StringUtils.isBlank(map.getIds())){
return Result.error("请选择数据!");
}
this.lawsStandardizationMeetingService.deleteByIds(Arrays.asList(map.get("ids").split(",")));
this.lawsStandardizationMeetingService.deleteByIds(Arrays.asList(map.getIds().split(",")));
return Result.OK("批量删除成功!");
}
@@ -143,7 +145,7 @@ public class LawsStandardizationMeetingController extends JeroController<LawsSta
@AutoLog(value = "标准化-参会记录-通过id查询")
@ApiOperation(value="标准化-参会记录-通过id查询", notes="标准化-参会记录-通过id查询")
@GetMapping(value = "/queryById")
public Result<LawsStandardizationMeeting> queryById(@RequestParam(name="id",required=true) String id) {
public Result<LawsStandardizationMeeting> queryById(@ApiParam("id") @RequestParam(name="id",required=true) String id) {
LawsStandardizationMeeting lawsStandardizationMeeting = lawsStandardizationMeetingService.queryById(id);
if(lawsStandardizationMeeting==null) {
return Result.error("未找到对应数据");
laws-modules/src/main/java/com/jero/modules/laws/standardization/controller/LawsStandardizationPaymentController.java
+14 -12
View File
@@ -6,8 +6,11 @@ import com.jero.common.aspect.annotation.AutoLog;
import com.jero.common.system.base.controller.JeroController;
import com.jero.modules.laws.standardization.entity.LawsStandardizationPayment;
import com.jero.modules.laws.standardization.service.ILawsStandardizationPaymentService;
import com.jero.modules.system.vo.IdMapBody;
import com.jero.modules.system.vo.IdsMapBody;
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;
@@ -20,7 +23,6 @@ import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
/**
@@ -50,8 +52,8 @@ public class LawsStandardizationPaymentController extends JeroController<LawsSta
@ApiOperation(value="标准化-支付信息-分页列表查询", notes="标准化-支付信息-分页列表查询")
@GetMapping(value = "/page")
public Result<IPage<LawsStandardizationPayment>> queryPageList(LawsStandardizationPayment lawsStandardizationPayment,
@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,
HttpServletRequest req) {
IPage<LawsStandardizationPayment> pageList = lawsStandardizationPaymentService.queryPage(lawsStandardizationPayment, pageNo, pageSize, req);
return Result.OK(pageList);
@@ -109,11 +111,11 @@ public class LawsStandardizationPaymentController extends JeroController<LawsSta
@AutoLog(value = "标准化-支付信息-通过id删除")
@ApiOperation(value="标准化-支付信息-通过id删除", notes="标准化-支付信息-通过id删除")
@PostMapping(value = "/delete")
public Result<T> delete(@RequestBody Map<String, String> map) {
if(!map.containsKey("id") || StringUtils.isEmpty(map.get("id"))){
return Result.error("请选择数据!");
}
lawsStandardizationPaymentService.deleteById(map.get("id"));
public Result<T> delete(@RequestBody IdMapBody map) {
if (StringUtils.isBlank(map.getId())){
return Result.error("请选择数据!");
}
lawsStandardizationPaymentService.deleteById(map.getId());
return Result.OK("删除成功!");
}
@@ -126,11 +128,11 @@ public class LawsStandardizationPaymentController extends JeroController<LawsSta
@AutoLog(value = "标准化-支付信息-批量删除")
@ApiOperation(value="标准化-支付信息-批量删除", notes="标准化-支付信息-批量删除")
@PostMapping(value = "/deleteBatch")
public Result<T> deleteBatch(@RequestBody Map<String, String> map) {
if(!map.containsKey("ids") || StringUtils.isEmpty(map.get("ids"))){
public Result<T> deleteBatch(@RequestBody IdsMapBody map) {
if (StringUtils.isBlank(map.getIds())){
return Result.error("请选择数据!");
}
this.lawsStandardizationPaymentService.deleteByIds(Arrays.asList(map.get("ids").split(",")));
this.lawsStandardizationPaymentService.deleteByIds(Arrays.asList(map.getIds().split(",")));
return Result.OK("批量删除成功!");
}
@@ -143,7 +145,7 @@ public class LawsStandardizationPaymentController extends JeroController<LawsSta
@AutoLog(value = "标准化-支付信息-通过id查询")
@ApiOperation(value="标准化-支付信息-通过id查询", notes="标准化-支付信息-通过id查询")
@GetMapping(value = "/queryById")
public Result<LawsStandardizationPayment> queryById(@RequestParam(name="id",required=true) String id) {
public Result<LawsStandardizationPayment> queryById(@ApiParam("id") @RequestParam(name="id",required=true) String id) {
LawsStandardizationPayment lawsStandardizationPayment = lawsStandardizationPaymentService.queryById(id);
if(lawsStandardizationPayment==null) {
return Result.error("未找到对应数据");