试验-规范管理-规范文件及文件夹集成swagger

blade-service/blade-business/src/main/java/org/springblade/business/controller/PrivateStandardController.java

@@ -4,6 +4,10 @@ package org.springblade.business.controller;
 import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
 import com.baomidou.mybatisplus.core.metadata.IPage;
 import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiImplicitParam;
+import io.swagger.annotations.ApiImplicitParams;
+import io.swagger.annotations.ApiOperation;
 import org.springblade.business.entity.PrivateStandard;
 import org.springblade.business.service.PrivateStandardService;
 import org.springblade.common.utils.SnowFlakeUtil;
@@ -24,6 +28,7 @@ import javax.annotation.Resource;
  */
 @RestController
 @RequestMapping("PrivateStandard")
+@Api(tags = "规范文件夹及规范文件接口")
 public class PrivateStandardController {
     /**
      * 服务对象
@@ -39,6 +44,11 @@ public class PrivateStandardController {
      * @return 所有数据
      */
     @GetMapping("page")
+    @ApiOperation(value = "分页查询所有数据", notes = "传入分页对象和高级查询对象")
+    @ApiImplicitParams({
+            @ApiImplicitParam(name = "query", value = "分页对象", required = true),
+            @ApiImplicitParam(name = "uWbsPrivateStandard", value = "高级查询对象", required = true)
+    })
     public R<IPage<PrivateStandard>> selectAll(Query query, PrivateStandard uWbsPrivateStandard) {
         try {
             Page page = new Page(query.getCurrent(), query.getSize());
@@ -57,6 +67,8 @@ public class PrivateStandardController {
      * @param id 主键
      * @return 单条数据
      */
+    @ApiOperation(value = "通过主键查询单条数据", notes = "传入主键Id")
+    @ApiImplicitParam(name = "id", value = "主键id", required = true)
     @GetMapping("/getById")
     public R<PrivateStandard> selectOne(Long id) {
         PrivateStandard byId = this.privateStandardService.getById(id);
@@ -70,6 +82,8 @@ public class PrivateStandardController {
      * @return 新增结果
      */
     @PostMapping("add")
+    @ApiOperation(value = "新增数据", notes = "传入新增对象")
+    @ApiImplicitParam(name = "uWbsPrivateStandard", value = "实体对象", required = true)
     public R<Boolean> insert(@RequestBody @Validated PrivateStandard uWbsPrivateStandard) {
         uWbsPrivateStandard.setId(SnowFlakeUtil.getId());
         if (uWbsPrivateStandard.getType() != 1 && uWbsPrivateStandard.getType() != 2) {
@@ -101,7 +115,9 @@ public class PrivateStandardController {
      * @param uWbsPrivateStandard 实体对象
      * @return 修改结果
      */
+    @ApiOperation(value = "修改数据")
     @PostMapping("edit")
+    @ApiImplicitParam(name = "uWbsPrivateStandard", value = "实体对象", required = true)
     public R<Boolean> update(@RequestBody @Validated PrivateStandard uWbsPrivateStandard) {
         BladeUser user = SecureUtil.getUser();
         uWbsPrivateStandard.setUpdateUser(user.getUserId());
@@ -115,7 +131,9 @@ public class PrivateStandardController {
      * @param id 主键
      * @return 删除结果
      */
+    @ApiOperation(value = "删除数据")
     @GetMapping("/delete")
+    @ApiImplicitParam(name = "id", value = "主键id", required = true)
     public R<Boolean> delete(Long id) {
         boolean b = this.privateStandardService.delete(id);
         return R.data(b);