ci: 所有接口swagger注释

This commit is contained in:
2023-11-20 16:36:02 +08:00
parent 6e1642e5b6
commit 5976ec50ae
8 changed files with 61 additions and 63 deletions
@@ -10,6 +10,7 @@ import com.jero.modules.laws.enterprise.entity.vo.EnterpriseStandardDeclareVo;
import com.jero.modules.laws.enterprise.service.EnterpriseStandardDeclareService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import lombok.extern.slf4j.Slf4j;
import org.apache.shiro.authz.annotation.RequiresPermissions;
import org.springframework.web.bind.annotation.*;
@@ -43,8 +44,8 @@ public class EnterpriseStandardDeclareController extends JeroController<Enterpri
@ApiOperation(value="企标宣贯-分页列表查询", notes="企标宣贯-分页列表查询")
@GetMapping(value = "/page")
public Result<?> queryPageList(ESQueryCommonDTO esDeclare,
@RequestParam(name="pageNo", defaultValue="1") Integer pageNo,
@RequestParam(name="pageSize", defaultValue="10") Integer pageSize) {
@RequestParam(name="pageNo", defaultValue="1") @ApiParam("页码") Integer pageNo,
@RequestParam(name="pageSize", defaultValue="10") @ApiParam("页面显示数量") Integer pageSize) {
IPage<EnterpriseStandardDeclareVo> pageList= esDeclareService.queryPageList(esDeclare, pageNo, pageSize);
return Result.OK(pageList);
}
@@ -16,6 +16,7 @@ import com.jero.modules.laws.enterprise.service.EnterpriseStandardInspectReportS
import com.jero.modules.laws.enterprise.service.EnterpriseStandardInspectService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import lombok.extern.slf4j.Slf4j;
import org.apache.shiro.authz.annotation.RequiresPermissions;
import org.springframework.web.bind.annotation.GetMapping;
@@ -62,8 +63,8 @@ public class EnterpriseStandardInspectController extends JeroController<Enterpri
@ApiOperation(value="企标稽查-分页列表查询", notes="企标稽查-分页列表查询")
@GetMapping(value = "/page")
public Result<?> queryPageList(ESQueryCommonDTO esInspect,
@RequestParam(name="pageNo", defaultValue="1") Integer pageNo,
@RequestParam(name="pageSize", defaultValue="10") Integer pageSize) {
@RequestParam(name="pageNo", defaultValue="1") @ApiParam("页码") Integer pageNo,
@RequestParam(name="pageSize", defaultValue="10") @ApiParam("页面显示数量") Integer pageSize) {
IPage<EnterpriseStandardInspectVo> pageList = esInspectService.queryPageList(esInspect, pageNo, pageSize);
return Result.OK(pageList);
}
@@ -77,7 +78,7 @@ public class EnterpriseStandardInspectController extends JeroController<Enterpri
@AutoLog(value = "企标稽查-延期稽查")
@ApiOperation(value="企标稽查-延期稽查", notes="企标稽查-延期稽查")
@GetMapping(value = "/delayInspect")
public Result<?> delayInspect(@RequestParam("id") String inspectId) {
public Result<?> delayInspect(@RequestParam("id") @ApiParam("稽查数据Id") String inspectId) {
EnterpriseStandardInspectDelay esInspectDelay = esInspectDelayService.getLastDelayInspect(inspectId);
return Result.OK(esInspectDelay);
}
@@ -91,9 +92,9 @@ public class EnterpriseStandardInspectController extends JeroController<Enterpri
@AutoLog(value = "企标稽查-稽查报告")
@ApiOperation(value="企标稽查-稽查报告", notes="企标稽查-稽查报告")
@GetMapping(value = "/inspectReport")
public Result<?> inspectReport(@RequestParam("id") String inspectId,
@RequestParam(name="pageNo", defaultValue="1") Integer pageNo,
@RequestParam(name="pageSize", defaultValue="10") Integer pageSize) {
public Result<?> inspectReport(@RequestParam("id") @ApiParam("稽查数据Id") String inspectId,
@RequestParam(name="pageNo", defaultValue="1") @ApiParam("页码") Integer pageNo,
@RequestParam(name="pageSize", defaultValue="10") @ApiParam("页面显示数量") Integer pageSize) {
IPage<EnterpriseStandardInspectReport> pageList = esInspectReportService.getInspectReport(inspectId, pageNo, pageSize);
return Result.OK(pageList);
}
@@ -107,9 +108,9 @@ public class EnterpriseStandardInspectController extends JeroController<Enterpri
@AutoLog(value = "企标稽查-整改计划")
@ApiOperation(value="企标稽查-整改计划", notes="企标稽查-整改计划")
@GetMapping(value = "/rectifyPlan")
public Result<?> rectifyPlan(@RequestParam("id") String inspectId,
@RequestParam(name="pageNo", defaultValue="1") Integer pageNo,
@RequestParam(name="pageSize", defaultValue="10") Integer pageSize) {
public Result<?> rectifyPlan(@RequestParam("id") @ApiParam("稽查数据Id") String inspectId,
@RequestParam(name="pageNo", defaultValue="1") @ApiParam("页码") Integer pageNo,
@RequestParam(name="pageSize", defaultValue="10") @ApiParam("页面显示数量") Integer pageSize) {
IPage<EnterpriseStandardInspectRectifyPlan> pageList = esInspectRectifyPlanService.getRectifyPlan(inspectId, pageNo, pageSize);
return Result.OK(pageList);
}
@@ -14,8 +14,10 @@ import com.jero.modules.laws.enterprise.entity.EnterpriseStandardPlan;
import com.jero.modules.laws.enterprise.entity.dto.ESPlanQueryDTO;
import com.jero.modules.laws.enterprise.entity.vo.EnterpriseStandardPlanVo;
import com.jero.modules.laws.enterprise.service.EnterpriseStandardPlanService;
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.poi.ss.formula.functions.T;
import org.apache.shiro.authz.annotation.RequiresPermissions;
@@ -52,8 +54,8 @@ public class EnterpriseStandardPlanController extends JeroController<EnterpriseS
@GetMapping(value = "/page")
@ApiOperationSupport(order = 1)
public Result<?> queryPageList(ESPlanQueryDTO esPlanQueryDTO,
@RequestParam(name="pageNo", defaultValue="1") Integer pageNo,
@RequestParam(name="pageSize", defaultValue="10") Integer pageSize) {
@RequestParam(name="pageNo", defaultValue="1") @ApiParam("页码") Integer pageNo,
@RequestParam(name="pageSize", defaultValue="10") @ApiParam("页面显示数量") Integer pageSize) {
IPage<EnterpriseStandardPlanVo> pageList= esPlanService.queryPageList(esPlanQueryDTO, pageNo, pageSize);
return Result.OK(pageList);
}
@@ -69,7 +71,7 @@ public class EnterpriseStandardPlanController extends JeroController<EnterpriseS
@ApiOperation(value="企标计划-企标详情", notes="企标计划-企标详情")
@GetMapping(value = "/detail")
@Translation
public Result<?> getDetailById(@RequestParam("id") String planId) {
public Result<?> getDetailById(@RequestParam("id") @ApiParam("企标计划ID") String planId) {
EnterpriseStandardPlan detail = esPlanService.getDetailById(planId);
return Result.OK(detail);
}
@@ -85,11 +87,11 @@ public class EnterpriseStandardPlanController extends JeroController<EnterpriseS
@ApiOperationSupport(order = 3)
@ApiOperation(value = "企标计划-通过id删除", notes = "企标计划-通过id删除")
@PostMapping(value = "/delete")
public Result<T> deleteEN(@RequestBody Map<String, String> map) {
if(!map.containsKey("id") || org.apache.commons.lang.StringUtils.isEmpty(map.get("id"))){
public Result<T> deleteEN(@RequestBody IdMapBody map) {
if(map.getId() == null || org.apache.commons.lang.StringUtils.isEmpty(map.getId())){
throw new JeroBootException(MessageUtils.getMessage(ResultCommon.PARAMETERS_CANNOT_BE_NULL));
}
String id = map.get("id");
String id = map.getId();
EnterpriseStandardPlan esPlan = esPlanService.getById(id);
if (esPlan == null) {
throw new JeroBootException(MessageUtils.getMessage(ResultCommon.NO_CORRESPONDING_RECORD_FOUND));
@@ -10,6 +10,7 @@ import com.jero.modules.laws.enterprise.entity.dto.ESQueryCommonDTO;
import com.jero.modules.laws.enterprise.service.EnterpriseStandardRecheckPlanService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import lombok.extern.slf4j.Slf4j;
import org.apache.shiro.authz.annotation.RequiresPermissions;
import org.springframework.web.bind.annotation.GetMapping;
@@ -47,8 +48,8 @@ public class EnterpriseStandardRecheckPlanController extends JeroController<Ente
@ApiOperation(value="企标复审计划-分页列表查询", notes="企标复审计划-分页列表查询")
@GetMapping(value = "/page")
public Result<?> queryPageList(ESQueryCommonDTO esDeclare,
@RequestParam(name="pageNo", defaultValue="1") Integer pageNo,
@RequestParam(name="pageSize", defaultValue="10") Integer pageSize) {
@RequestParam(name="pageNo", defaultValue="1") @ApiParam("页码") Integer pageNo,
@RequestParam(name="pageSize", defaultValue="10") @ApiParam("页面显示数量") Integer pageSize) {
return Result.OK(recheckPlanService.queryPageList(esDeclare, pageNo, pageSize));
}
}
@@ -14,6 +14,7 @@ import com.jero.modules.laws.enterprise.entity.vo.EnterpriseStandardReviewMeetin
import com.jero.modules.laws.enterprise.service.EnterpriseStandardReviewMeetingRecordService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import lombok.extern.slf4j.Slf4j;
import org.apache.shiro.authz.annotation.RequiresPermissions;
import org.springframework.web.bind.annotation.*;
@@ -49,8 +50,8 @@ public class EnterpriseStandardReviewMeetingController extends JeroController<En
@ApiOperation(value = "企标评审会-分页列表查询", notes = "企标评审会-分页列表查询")
@GetMapping(value = "/page")
public Result<?> queryPageList(ESQueryCommonDTO esReviewMeeting,
@RequestParam(name = "pageNo", defaultValue = "1") Integer pageNo,
@RequestParam(name = "pageSize", defaultValue = "10") Integer pageSize) {
@RequestParam(name = "pageNo", defaultValue = "1") @ApiParam("页码") Integer pageNo,
@RequestParam(name = "pageSize", defaultValue = "10") @ApiParam("页面显示数量") Integer pageSize) {
IPage<EnterpriseStandardReviewMeetingVo> pageList = esReviewMeetingService.queryPageList(esReviewMeeting, pageNo, pageSize);
return Result.OK(pageList);
}
@@ -64,7 +65,7 @@ public class EnterpriseStandardReviewMeetingController extends JeroController<En
@AutoLog(value = "企标评审会-评分详情")
@ApiOperation(value = "企标评审会-评分详情", notes = "企标评审会-评分详情")
@GetMapping(value = "/evaluateDetail/{id}")
public Result<?> evaluateDetail(@PathVariable("id") String id) {
public Result<?> evaluateDetail(@PathVariable("id") @ApiParam("企标评审Id") String id) {
Map<String, List<EnterpriseStandardRmrEvaluateDetail>> resultMap = esReviewMeetingService.evaluateDetail(id);
return Result.OK(resultMap);
}
@@ -78,7 +79,7 @@ public class EnterpriseStandardReviewMeetingController extends JeroController<En
@AutoLog(value = "企标评审会-设置优质标准")
@ApiOperation(value = "企标评审会-设置优质标准", notes = "企标评审会-设置优质标准")
@GetMapping(value = "/setQualityStandards")
public Result<?> setQualityStandards(@RequestParam String standardNos) {
public Result<?> setQualityStandards(@RequestParam @ApiParam("标准编号") String standardNos) {
List<String> standardNoList = Arrays.asList(standardNos.split(","));
if (standardNoList.size() > 10) {
throw new JeroBootException(MessageUtils.getMessage(ResultCommon.RMR_SET_QUALITY_OVER_TEN));