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/SysOssConfigController.java | 19 ++++++------------- 1 files changed, 6 insertions(+), 13 deletions(-) diff --git a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysOssConfigController.java b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysOssConfigController.java index cf2fd11..023f349 100644 --- a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysOssConfigController.java +++ b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysOssConfigController.java @@ -4,8 +4,8 @@ import com.ruoyi.common.annotation.Log; import com.ruoyi.common.annotation.RepeatSubmit; import com.ruoyi.common.core.controller.BaseController; -import com.ruoyi.common.core.domain.R; 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; @@ -14,9 +14,8 @@ 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.annotations.ApiParam; +import io.swagger.v3.oas.annotations.Parameter; +import io.swagger.v3.oas.annotations.tags.Tag; import lombok.RequiredArgsConstructor; import org.springframework.validation.annotation.Validated; import org.springframework.web.bind.annotation.*; @@ -33,7 +32,7 @@ * @date 2021-08-13 */ @Validated -@Api(value = "瀵硅薄瀛樺偍閰嶇疆鎺у埗鍣�", tags = {"瀵硅薄瀛樺偍閰嶇疆绠$悊"}) +@Tag(name ="瀵硅薄瀛樺偍閰嶇疆鎺у埗鍣�", description = "瀵硅薄瀛樺偍閰嶇疆绠$悊") @RequiredArgsConstructor @RestController @RequestMapping("/system/oss/config") @@ -44,7 +43,6 @@ /** * 鏌ヨ瀵硅薄瀛樺偍閰嶇疆鍒楄〃 */ - @ApiOperation("鏌ヨ瀵硅薄瀛樺偍閰嶇疆鍒楄〃") @SaCheckPermission("system:oss:list") @GetMapping("/list") public TableDataInfo<SysOssConfigVo> list(@Validated(QueryGroup.class) SysOssConfigBo bo, PageQuery pageQuery) { @@ -54,10 +52,9 @@ /** * 鑾峰彇瀵硅薄瀛樺偍閰嶇疆璇︾粏淇℃伅 */ - @ApiOperation("鑾峰彇瀵硅薄瀛樺偍閰嶇疆璇︾粏淇℃伅") @SaCheckPermission("system:oss:query") @GetMapping("/{ossConfigId}") - public R<SysOssConfigVo> getInfo(@ApiParam("OSS閰嶇疆ID") + public R<SysOssConfigVo> getInfo(@Parameter(name = "OSS閰嶇疆ID") @NotNull(message = "涓婚敭涓嶈兘涓虹┖") @PathVariable("ossConfigId") Long ossConfigId) { return R.ok(iSysOssConfigService.queryById(ossConfigId)); @@ -66,7 +63,6 @@ /** * 鏂板瀵硅薄瀛樺偍閰嶇疆 */ - @ApiOperation("鏂板瀵硅薄瀛樺偍閰嶇疆") @SaCheckPermission("system:oss:add") @Log(title = "瀵硅薄瀛樺偍閰嶇疆", businessType = BusinessType.INSERT) @RepeatSubmit() @@ -78,7 +74,6 @@ /** * 淇敼瀵硅薄瀛樺偍閰嶇疆 */ - @ApiOperation("淇敼瀵硅薄瀛樺偍閰嶇疆") @SaCheckPermission("system:oss:edit") @Log(title = "瀵硅薄瀛樺偍閰嶇疆", businessType = BusinessType.UPDATE) @RepeatSubmit() @@ -90,11 +85,10 @@ /** * 鍒犻櫎瀵硅薄瀛樺偍閰嶇疆 */ - @ApiOperation("鍒犻櫎瀵硅薄瀛樺偍閰嶇疆") @SaCheckPermission("system:oss:remove") @Log(title = "瀵硅薄瀛樺偍閰嶇疆", businessType = BusinessType.DELETE) @DeleteMapping("/{ossConfigIds}") - public R<Void> remove(@ApiParam("OSS閰嶇疆ID涓�") + public R<Void> remove(@Parameter(name = "OSS閰嶇疆ID涓�") @NotEmpty(message = "涓婚敭涓嶈兘涓虹┖") @PathVariable Long[] ossConfigIds) { return toAjax(iSysOssConfigService.deleteWithValidByIds(Arrays.asList(ossConfigIds), true) ? 1 : 0); @@ -103,7 +97,6 @@ /** * 鐘舵�佷慨鏀� */ - @ApiOperation("鐘舵�佷慨鏀�") @SaCheckPermission("system:oss:edit") @Log(title = "瀵硅薄瀛樺偍鐘舵�佷慨鏀�", businessType = BusinessType.UPDATE) @PutMapping("/changeStatus") -- Gitblit v1.9.3