admin/lx-admin-backend
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update 更新 swagger 注解用法

Browse Source
This commit is contained in:
疯狂的狮子li 2022-02-09 19:44:48 +08:00
parent d99dd4b875
commit 7bd34cb1da
3 changed files with 6 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysOssController.java
View File

@ -15,10 +15,7 @@ import com.ruoyi.common.core.page.TableDataInfo;
import com.ruoyi.common.core.validate.QueryGroup; import com.ruoyi.common.core.validate.QueryGroup;
import com.ruoyi.common.enums.BusinessType; import com.ruoyi.common.enums.BusinessType;
import com.ruoyi.common.exception.ServiceException; import com.ruoyi.common.exception.ServiceException;
import com.ruoyi.common.utils.JsonUtils;
import com.ruoyi.common.utils.file.FileUtils; import com.ruoyi.common.utils.file.FileUtils;
import com.ruoyi.oss.constant.OssConstant;
import com.ruoyi.system.domain.SysConfig;
import com.ruoyi.system.domain.SysOss; import com.ruoyi.system.domain.SysOss;
import com.ruoyi.system.domain.bo.SysOssBo; import com.ruoyi.system.domain.bo.SysOssBo;
import com.ruoyi.system.domain.vo.SysOssVo; import com.ruoyi.system.domain.vo.SysOssVo;
@ -45,7 +42,7 @@ import java.util.Map;
* @author Lion Li * @author Lion Li
*/ */
@Validated @Validated
@Api(value = "OSS对象存储控制器", tags = {"OSS对象存储管理"}) @Api(value = "对象存储控制器", tags = {"对象存储管理"})
@RequiredArgsConstructor @RequiredArgsConstructor
@RestController @RestController
@RequestMapping("/system/oss") @RequestMapping("/system/oss")
@ -69,7 +66,7 @@ public class SysOssController extends BaseController {
*/ */
@ApiOperation("上传OSS对象存储") @ApiOperation("上传OSS对象存储")
@ApiImplicitParams({ @ApiImplicitParams({
@ApiImplicitParam(name = "file", value = "文件", dataTypeClass = File.class, required = true), @ApiImplicitParam(name = "file", value = "文件", paramType = "query", dataTypeClass = File.class, required = true)
}) })
@SaCheckPermission("system:oss:upload") @SaCheckPermission("system:oss:upload")
@Log(title = "OSS对象存储", businessType = BusinessType.INSERT) @Log(title = "OSS对象存储", businessType = BusinessType.INSERT)

2
ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysProfileController.java
View File

@ -109,7 +109,7 @@ public class SysProfileController extends BaseController {
*/ */
@ApiOperation("头像上传") @ApiOperation("头像上传")
@ApiImplicitParams({ @ApiImplicitParams({
@ApiImplicitParam(name = "avatarfile", value = "用户头像", dataTypeClass = File.class, required = true), @ApiImplicitParam(name = "avatarfile", value = "用户头像", paramType = "query", dataTypeClass = File.class, required = true)
}) })
@Log(title = "用户头像", businessType = BusinessType.UPDATE) @Log(title = "用户头像", businessType = BusinessType.UPDATE)
@PostMapping("/avatar") @PostMapping("/avatar")

5
ruoyi-demo/src/main/java/com/ruoyi/demo/controller/Swagger3DemoController.java
View File

@ -11,6 +11,8 @@ import org.springframework.web.bind.annotation.RequestPart;
import org.springframework.web.bind.annotation.RestController; import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile; import org.springframework.web.multipart.MultipartFile;
import java.io.File;
/** /**
* swagger3 用法示例 * swagger3 用法示例
* *
@ -24,11 +26,10 @@ public class Swagger3DemoController {
/** /**
* 上传请求 * 上传请求
* 必须使用 @RequestPart 注解标注为文件 * 必须使用 @RequestPart 注解标注为文件
* dataType 必须为 "java.io.File"
*/ */
@ApiOperation(value = "通用上传请求") @ApiOperation(value = "通用上传请求")
@ApiImplicitParams({ @ApiImplicitParams({
@ApiImplicitParam(name = "file", value = "文件", dataType = "java.io.File", required = true), @ApiImplicitParam(name = "file", value = "文件", paramType = "query", dataTypeClass = File.class, required = true)
}) })
@PostMapping(value = "/upload") @PostMapping(value = "/upload")
public R<String> upload(@RequestPart("file") MultipartFile file) { public R<String> upload(@RequestPart("file") MultipartFile file) {