remove 移除所有 swagger 配置 准备对接 springdoc

ruoyi-modules/ruoyi-resource/src/main/java/com/ruoyi/resource/controller/SysOssConfigController.java

@@ -13,9 +13,6 @@ import com.ruoyi.common.mybatis.core.page.TableDataInfo;
 import com.ruoyi.resource.domain.bo.SysOssConfigBo;
 import com.ruoyi.resource.domain.vo.SysOssConfigVo;
 import com.ruoyi.resource.service.ISysOssConfigService;
-import io.swagger.annotations.Api;
-import io.swagger.annotations.ApiOperation;
-import io.swagger.annotations.ApiParam;
 import lombok.RequiredArgsConstructor;
 import org.springframework.validation.annotation.Validated;
 import org.springframework.web.bind.annotation.*;
@@ -32,7 +29,6 @@ import java.util.Arrays;
  * @date 2021-08-13
  */
 @Validated
-@Api(value = "对象存储配置控制器", tags = {"对象存储配置管理"})
 @RequiredArgsConstructor
 @RestController
 @RequestMapping("/oss/config")
@@ -43,7 +39,6 @@ public class SysOssConfigController extends BaseController {
     /**
      * 查询对象存储配置列表
      */
-    @ApiOperation("查询对象存储配置列表")
     @SaCheckPermission("system:oss:list")
     @GetMapping("/list")
     public TableDataInfo<SysOssConfigVo> list(@Validated(QueryGroup.class) SysOssConfigBo bo, PageQuery pageQuery) {
@@ -52,20 +47,18 @@ public class SysOssConfigController extends BaseController {
 
     /**
      * 获取对象存储配置详细信息
+     *
+     * @param ossConfigId OSS配置ID
      */
-    @ApiOperation("获取对象存储配置详细信息")
     @SaCheckPermission("system:oss:query")
     @GetMapping("/{ossConfigId}")
-    public R<SysOssConfigVo> getInfo(@ApiParam("OSS配置ID")
-                                              @NotNull(message = "主键不能为空")
-                                              @PathVariable("ossConfigId") Long ossConfigId) {
+    public R<SysOssConfigVo> getInfo(@NotNull(message = "主键不能为空") @PathVariable("ossConfigId") Long ossConfigId) {
         return R.ok(iSysOssConfigService.queryById(ossConfigId));
     }
 
     /**
      * 新增对象存储配置
      */
-    @ApiOperation("新增对象存储配置")
     @SaCheckPermission("system:oss:add")
     @Log(title = "对象存储配置", businessType = BusinessType.INSERT)
     @PostMapping()
@@ -76,7 +69,6 @@ public class SysOssConfigController extends BaseController {
     /**
      * 修改对象存储配置
      */
-    @ApiOperation("修改对象存储配置")
     @SaCheckPermission("system:oss:edit")
     @Log(title = "对象存储配置", businessType = BusinessType.UPDATE)
     @PutMapping()
@@ -86,21 +78,19 @@ public class SysOssConfigController extends BaseController {
 
     /**
      * 删除对象存储配置
+     *
+     * @param ossConfigIds OSS配置ID串
      */
-    @ApiOperation("删除对象存储配置")
     @SaCheckPermission("system:oss:remove")
     @Log(title = "对象存储配置", businessType = BusinessType.DELETE)
     @DeleteMapping("/{ossConfigIds}")
-    public R<Void> remove(@ApiParam("OSS配置ID串")
-                                   @NotEmpty(message = "主键不能为空")
-                                   @PathVariable Long[] ossConfigIds) {
+    public R<Void> remove(@NotEmpty(message = "主键不能为空") @PathVariable Long[] ossConfigIds) {
         return toAjax(iSysOssConfigService.deleteWithValidByIds(Arrays.asList(ossConfigIds), true) ? 1 : 0);
     }
 
     /**
      * 状态修改
      */
-    @ApiOperation("状态修改")
     @SaCheckPermission("system:oss:edit")
     @Log(title = "对象存储状态修改", businessType = BusinessType.UPDATE)
     @PutMapping("/changeStatus")

ruoyi-modules/ruoyi-resource/src/main/java/com/ruoyi/resource/controller/SysOssController.java

@@ -19,7 +19,6 @@ import com.ruoyi.resource.domain.SysOss;
 import com.ruoyi.resource.domain.bo.SysOssBo;
 import com.ruoyi.resource.domain.vo.SysOssVo;
 import com.ruoyi.resource.service.ISysOssService;
-import io.swagger.annotations.*;
 import lombok.RequiredArgsConstructor;
 import org.springframework.http.MediaType;
 import org.springframework.validation.annotation.Validated;
@@ -28,7 +27,6 @@ import org.springframework.web.multipart.MultipartFile;
 
 import javax.servlet.http.HttpServletResponse;
 import javax.validation.constraints.NotEmpty;
-import java.io.File;
 import java.io.IOException;
 import java.util.Arrays;
 import java.util.HashMap;
@@ -41,7 +39,6 @@ import java.util.Map;
  * @author Lion Li
  */
 @Validated
-@Api(value = "对象存储控制器", tags = {"对象存储管理"})
 @RequiredArgsConstructor
 @RestController
 @RequestMapping("/oss")
@@ -52,7 +49,6 @@ public class SysOssController extends BaseController {
     /**
      * 查询OSS对象存储列表
      */
-    @ApiOperation("查询OSS对象存储列表")
     @SaCheckPermission("system:oss:list")
     @GetMapping("/list")
     public TableDataInfo<SysOssVo> list(@Validated(QueryGroup.class) SysOssBo bo, PageQuery pageQuery) {
@@ -61,27 +57,24 @@ public class SysOssController extends BaseController {
 
     /**
      * 查询OSS对象基于id串
+     *
+     * @param ossIds OSS对象ID串
      */
-    @ApiOperation("查询OSS对象基于ID")
     @SaCheckPermission("system:oss:list")
     @GetMapping("/listByIds/{ossIds}")
-    public R<List<SysOssVo>> listByIds(@ApiParam("OSS对象ID串")
-                                       @NotEmpty(message = "主键不能为空")
-                                       @PathVariable Long[] ossIds) {
+    public R<List<SysOssVo>> listByIds(@NotEmpty(message = "主键不能为空") @PathVariable Long[] ossIds) {
         List<SysOssVo> list = iSysOssService.listByIds(Arrays.asList(ossIds));
         return R.ok(list);
     }
 
     /**
      * 上传OSS对象存储
+     *
+     * @param file 文件
      */
-    @ApiOperation("上传OSS对象存储")
-    @ApiImplicitParams({
-        @ApiImplicitParam(name = "file", value = "文件", paramType = "query", dataTypeClass = File.class, required = true)
-    })
     @SaCheckPermission("system:oss:upload")
     @Log(title = "OSS对象存储", businessType = BusinessType.INSERT)
-    @PostMapping("/upload")
+    @PostMapping(value = "/upload", consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
     public R<Map<String, String>> upload(@RequestPart("file") MultipartFile file) {
         if (ObjectUtil.isNull(file)) {
             throw new ServiceException("上传文件不能为空");
@@ -94,10 +87,14 @@ public class SysOssController extends BaseController {
         return R.ok(map);
     }
 
-    @ApiOperation("下载OSS对象存储")
+    /**
+     * 下载OSS对象存储
+     *
+     * @param ossId OSS对象ID
+     */
     @SaCheckPermission("system:oss:download")
     @GetMapping("/download/{ossId}")
-    public void download(@ApiParam("OSS对象ID") @PathVariable Long ossId, HttpServletResponse response) throws IOException {
+    public void download(@PathVariable Long ossId, HttpServletResponse response) throws IOException {
         SysOss sysOss = iSysOssService.getById(ossId);
         if (ObjectUtil.isNull(sysOss)) {
             throw new ServiceException("文件数据不存在!");
@@ -120,14 +117,13 @@ public class SysOssController extends BaseController {
 
     /**
      * 删除OSS对象存储
+     *
+     * @param ossIds OSS对象ID串
      */
-    @ApiOperation("删除OSS对象存储")
     @SaCheckPermission("system:oss:remove")
     @Log(title = "OSS对象存储", businessType = BusinessType.DELETE)
     @DeleteMapping("/{ossIds}")
-    public R<Void> remove(@ApiParam("OSS对象ID串")
-                                   @NotEmpty(message = "主键不能为空")
-                                   @PathVariable Long[] ossIds) {
+    public R<Void> remove(@NotEmpty(message = "主键不能为空") @PathVariable Long[] ossIds) {
         return toAjax(iSysOssService.deleteWithValidByIds(Arrays.asList(ossIds), true) ? 1 : 0);
     }
 

ruoyi-modules/ruoyi-resource/src/main/java/com/ruoyi/resource/controller/SysSmsController.java

@@ -10,9 +10,6 @@ import com.ruoyi.common.redis.utils.RedisUtils;
 import com.ruoyi.common.sms.config.properties.SmsProperties;
 import com.ruoyi.common.sms.core.SmsTemplate;
 import com.ruoyi.common.sms.entity.SmsResult;
-import io.swagger.annotations.Api;
-import io.swagger.annotations.ApiOperation;
-import io.swagger.annotations.ApiParam;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.validation.annotation.Validated;
@@ -32,7 +29,6 @@ import java.util.Map;
  */
 @Slf4j
 @Validated
-@Api(value = "短信功能控制器", tags = {"短信功能管理"})
 @RequiredArgsConstructor
 @RestController
 @RequestMapping("/sms")
@@ -42,12 +38,11 @@ public class SysSmsController extends BaseController {
 
     /**
      * 短信验证码
+     *
+     * @param phonenumber 用户手机号
      */
-    @ApiOperation("短信验证码")
     @GetMapping("/code")
-    public R<Void> smsCaptcha(@ApiParam("用户手机号")
-                              @NotBlank(message = "{user.phonenumber.not.blank}")
-                              String phonenumber) {
+    public R<Void> smsCaptcha(@NotBlank(message = "{user.phonenumber.not.blank}") String phonenumber) {
         if (smsProperties.getEnabled()) {
             R.fail("当前系统没有开启短信功能！");
         }