add 整合 springdoc-openapi-javadoc 基于代码注释生成文档

疯狂的狮子li

2022-07-07 d9e54388e7fde2462e8b7e0165c5e7da3f202593

 ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysOssConfigController.java

@@ -1,126 +1,106 @@
package com.ruoyi.web.controller.system;

import cn.hutool.core.util.ObjectUtil;
import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
import cn.dev33.satoken.annotation.SaCheckPermission;
import com.ruoyi.common.annotation.Log;
import com.ruoyi.common.annotation.RepeatSubmit;
import com.ruoyi.common.constant.Constants;
import com.ruoyi.common.constant.UserConstants;
import com.ruoyi.common.core.controller.BaseController;
import com.ruoyi.common.core.domain.AjaxResult;
import com.ruoyi.common.core.domain.PageQuery;
import com.ruoyi.common.core.domain.R;
import com.ruoyi.common.core.page.TableDataInfo;
import com.ruoyi.common.core.validate.AddGroup;
import com.ruoyi.common.core.validate.EditGroup;
import com.ruoyi.common.core.validate.QueryGroup;
import com.ruoyi.common.enums.BusinessType;
import com.ruoyi.common.utils.StringUtils;
import com.ruoyi.system.domain.SysOssConfig;
import com.ruoyi.system.domain.bo.SysOssConfigBo;
import com.ruoyi.system.domain.vo.SysOssConfigVo;
import com.ruoyi.system.service.ISysOssConfigService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;

import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.NotNull;
import java.util.Arrays;
import java.util.List;

/**
 * 云存储配置Controller
 * 对象存储配置Controller
 *
 * @author ruoyi
 * @date 2021-08-11
 * @author Lion Li
 * @author 孤舟烟雨
 * @date 2021-08-13
 */
@Validated
@Api(value = "云存储配置控制器", tags = {"云存储配置管理"})
@RequiredArgsConstructor(onConstructor_ = @Autowired)
@Tag(name ="对象存储配置控制器", description = "对象存储配置管理")
@RequiredArgsConstructor
@RestController
@RequestMapping("/system/sysOssConfig")
@RequestMapping("/system/oss/config")
public class SysOssConfigController extends BaseController {

   private final ISysOssConfigService iSysOssConfigService;
    private final ISysOssConfigService iSysOssConfigService;

   /**
    * 查询云存储配置列表
    */
   @ApiOperation("查询云存储配置列表")
   @PreAuthorize("@ss.hasPermi('system:sysOssConfig:list')")
   @GetMapping("/list")
   public TableDataInfo<SysOssConfigVo> list(@Validated SysOssConfigBo bo) {
      return iSysOssConfigService.queryPageList(bo);
   }
    /**
     * 查询对象存储配置列表
     */
    @SaCheckPermission("system:oss:list")
    @GetMapping("/list")
    public TableDataInfo<SysOssConfigVo> list(@Validated(QueryGroup.class) SysOssConfigBo bo, PageQuery pageQuery) {
        return iSysOssConfigService.queryPageList(bo, pageQuery);
    }

   /**
    * 获取云存储配置详细信息
    */
   @ApiOperation("获取云存储配置详细信息")
   @PreAuthorize("@ss.hasPermi('system:sysOssConfig:query')")
   @GetMapping("/{ossConfigId}")
   public AjaxResult<SysOssConfigVo> getInfo(@NotNull(message = "主键不能为空")
                                   @PathVariable("ossConfigId") Integer ossConfigId) {
      return AjaxResult.success(iSysOssConfigService.queryById(ossConfigId));
   }
    /**
     * 获取对象存储配置详细信息
     */
    @SaCheckPermission("system:oss:query")
    @GetMapping("/{ossConfigId}")
    public R<SysOssConfigVo> getInfo(@Parameter(name = "OSS配置ID")
                                              @NotNull(message = "主键不能为空")
                                              @PathVariable("ossConfigId") Long ossConfigId) {
        return R.ok(iSysOssConfigService.queryById(ossConfigId));
    }

   /**
    * 新增云存储配置
    */
   @ApiOperation("新增云存储配置")
   @PreAuthorize("@ss.hasPermi('system:sysOssConfig:add')")
   @Log(title = "云存储配置", businessType = BusinessType.INSERT)
   @RepeatSubmit()
   @PostMapping()
   public AjaxResult<Void> add(@Validated(AddGroup.class) @RequestBody SysOssConfigBo bo) {
      if (StringUtils.isNotEmpty(bo.getConfigKey())
         && UserConstants.NOT_UNIQUE.equals(iSysOssConfigService.checkConfigKeyUnique(bo))) {
         return AjaxResult.error("新增云配置'" + bo.getConfigKey() + "'失败，configKey已存在");
      }
      return toAjax(iSysOssConfigService.insertByBo(bo) ? 1 : 0);
   }
    /**
     * 新增对象存储配置
     */
    @SaCheckPermission("system:oss:add")
    @Log(title = "对象存储配置", businessType = BusinessType.INSERT)
    @RepeatSubmit()
    @PostMapping()
    public R<Void> add(@Validated(AddGroup.class) @RequestBody SysOssConfigBo bo) {
        return toAjax(iSysOssConfigService.insertByBo(bo) ? 1 : 0);
    }

   /**
    * 修改云存储配置
    */
   @ApiOperation("修改云存储配置")
   @PreAuthorize("@ss.hasPermi('system:sysOssConfig:edit')")
   @Log(title = "云存储配置", businessType = BusinessType.UPDATE)
   @RepeatSubmit()
   @PutMapping()
   public AjaxResult<Void> edit(@Validated(EditGroup.class) @RequestBody SysOssConfigBo bo) {
      if (StringUtils.isNotEmpty(bo.getConfigKey())
         && UserConstants.NOT_UNIQUE.equals(iSysOssConfigService.checkConfigKeyUnique(bo))) {
         return AjaxResult.error("修改云配置'" + bo.getConfigKey() + "'失败，configKey已存在");
      }
      return toAjax(iSysOssConfigService.updateByBo(bo) ? 1 : 0);
   }
    /**
     * 修改对象存储配置
     */
    @SaCheckPermission("system:oss:edit")
    @Log(title = "对象存储配置", businessType = BusinessType.UPDATE)
    @RepeatSubmit()
    @PutMapping()
    public R<Void> edit(@Validated(EditGroup.class) @RequestBody SysOssConfigBo bo) {
        return toAjax(iSysOssConfigService.updateByBo(bo) ? 1 : 0);
    }

   /**
    * 删除云存储配置
    */
   @ApiOperation("删除云存储配置")
   @PreAuthorize("@ss.hasPermi('system:sysOssConfig:remove')")
   @Log(title = "云存储配置", businessType = BusinessType.DELETE)
   @DeleteMapping("/{ossConfigIds}")
   public AjaxResult<Void> remove(@NotEmpty(message = "主键不能为空")
                           @PathVariable Integer[] ossConfigIds) {
      List<SysOssConfig> list = iSysOssConfigService.list();
      if(ObjectUtil.isNotNull(list)&&list.size()==1){
         return AjaxResult.error("必须保留一条云配置文件");
      }
      return toAjax(iSysOssConfigService.deleteWithValidByIds(Arrays.asList(ossConfigIds), true) ? 1 : 0);
   }
    /**
     * 删除对象存储配置
     */
    @SaCheckPermission("system:oss:remove")
    @Log(title = "对象存储配置", businessType = BusinessType.DELETE)
    @DeleteMapping("/{ossConfigIds}")
    public R<Void> remove(@Parameter(name = "OSS配置ID串")
                                   @NotEmpty(message = "主键不能为空")
                                   @PathVariable Long[] ossConfigIds) {
        return toAjax(iSysOssConfigService.deleteWithValidByIds(Arrays.asList(ossConfigIds), true) ? 1 : 0);
    }

   /**
    * 状态修改
    */
   @PreAuthorize("@ss.hasPermi('system:sysOssConfig:edit')")
   @Log(title = "云存储状态修改", businessType = BusinessType.UPDATE)
   @PutMapping("/changeStatus")
   public AjaxResult changeStatus(@RequestBody SysOssConfig sysOssConfig) {
      return toAjax(iSysOssConfigService.updateOssConfigStatus(sysOssConfig));
   }
    /**
     * 状态修改
     */
    @SaCheckPermission("system:oss:edit")
    @Log(title = "对象存储状态修改", businessType = BusinessType.UPDATE)
    @PutMapping("/changeStatus")
    public R<Void> changeStatus(@RequestBody SysOssConfigBo bo) {
        return toAjax(iSysOssConfigService.updateOssConfigStatus(bo));
    }
}