From d9e54388e7fde2462e8b7e0165c5e7da3f202593 Mon Sep 17 00:00:00 2001
From: 疯狂的狮子li <15040126243@163.com>
Date: 星期四, 07 七月 2022 19:07:59 +0800
Subject: [PATCH] add 整合 springdoc-openapi-javadoc 基于代码注释生成文档
---
ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysOssController.java | 33 ++++++++++++++++++++++-----------
1 files changed, 22 insertions(+), 11 deletions(-)
diff --git a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysOssController.java b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysOssController.java
index a128a15..e40c2f5 100644
--- a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysOssController.java
+++ b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysOssController.java
@@ -19,7 +19,10 @@
import com.ruoyi.system.domain.bo.SysOssBo;
import com.ruoyi.system.domain.vo.SysOssVo;
import com.ruoyi.system.service.ISysOssService;
-import io.swagger.annotations.*;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.Parameters;
+import io.swagger.v3.oas.annotations.enums.ParameterIn;
+import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import org.springframework.http.MediaType;
import org.springframework.validation.annotation.Validated;
@@ -28,10 +31,10 @@
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;
+import java.util.List;
import java.util.Map;
/**
@@ -40,7 +43,7 @@
* @author Lion Li
*/
@Validated
-@Api(value = "瀵硅薄瀛樺偍鎺у埗鍣�", tags = {"瀵硅薄瀛樺偍绠＄悊"})
+@Tag(name ="瀵硅薄瀛樺偍鎺у埗鍣�", description = "瀵硅薄瀛樺偍绠＄悊")
@RequiredArgsConstructor
@RestController
@RequestMapping("/system/oss")
@@ -51,7 +54,6 @@
/**
* 鏌ヨOSS瀵硅薄瀛樺偍鍒楄〃
*/
- @ApiOperation("鏌ヨOSS瀵硅薄瀛樺偍鍒楄〃")
@SaCheckPermission("system:oss:list")
@GetMapping("/list")
public TableDataInfo<SysOssVo> list(@Validated(QueryGroup.class) SysOssBo bo, PageQuery pageQuery) {
@@ -59,11 +61,22 @@
}
/**
+ * 鏌ヨOSS瀵硅薄鍩轰簬id涓�
+ */
+ @SaCheckPermission("system:oss:list")
+ @GetMapping("/listByIds/{ossIds}")
+ public R<List<SysOssVo>> listByIds(@Parameter(name = "OSS瀵硅薄ID涓�")
+ @NotEmpty(message = "涓婚敭涓嶈兘涓虹┖")
+ @PathVariable Long[] ossIds) {
+ List<SysOssVo> list = iSysOssService.listByIds(Arrays.asList(ossIds));
+ return R.ok(list);
+ }
+
+ /**
* 涓婁紶OSS瀵硅薄瀛樺偍
*/
- @ApiOperation("涓婁紶OSS瀵硅薄瀛樺偍")
- @ApiImplicitParams({
- @ApiImplicitParam(name = "file", value = "鏂囦欢", paramType = "query", dataTypeClass = File.class, required = true)
+ @Parameters({
+ @Parameter(name = "file", description = "鏂囦欢", in = ParameterIn.QUERY, required = true)
})
@SaCheckPermission("system:oss:upload")
@Log(title = "OSS瀵硅薄瀛樺偍", businessType = BusinessType.INSERT)
@@ -80,10 +93,9 @@
return R.ok(map);
}
- @ApiOperation("涓嬭浇OSS瀵硅薄瀛樺偍")
@SaCheckPermission("system:oss:download")
@GetMapping("/download/{ossId}")
- public void download(@ApiParam("OSS瀵硅薄ID") @PathVariable Long ossId, HttpServletResponse response) throws IOException {
+ public void download(@Parameter(name = "OSS瀵硅薄ID") @PathVariable Long ossId, HttpServletResponse response) throws IOException {
SysOss sysOss = iSysOssService.getById(ossId);
if (ObjectUtil.isNull(sysOss)) {
throw new ServiceException("鏂囦欢鏁版嵁涓嶅瓨鍦�!");
@@ -107,11 +119,10 @@
/**
* 鍒犻櫎OSS瀵硅薄瀛樺偍
*/
- @ApiOperation("鍒犻櫎OSS瀵硅薄瀛樺偍")
@SaCheckPermission("system:oss:remove")
@Log(title = "OSS瀵硅薄瀛樺偍", businessType = BusinessType.DELETE)
@DeleteMapping("/{ossIds}")
- public R<Void> remove(@ApiParam("OSS瀵硅薄ID涓�")
+ public R<Void> remove(@Parameter(name = "OSS瀵硅薄ID涓�")
@NotEmpty(message = "涓婚敭涓嶈兘涓虹┖")
@PathVariable Long[] ossIds) {
return toAjax(iSysOssService.deleteWithValidByIds(Arrays.asList(ossIds), true) ? 1 : 0);
--
Gitblit v1.9.3