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/SysConfigController.java | 24 +++++++-----------------
1 files changed, 7 insertions(+), 17 deletions(-)
diff --git a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysConfigController.java b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysConfigController.java
index 2dcb843..3e26979 100644
--- a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysConfigController.java
+++ b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysConfigController.java
@@ -4,16 +4,15 @@
import com.ruoyi.common.annotation.Log;
import com.ruoyi.common.constant.UserConstants;
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.enums.BusinessType;
import com.ruoyi.common.utils.poi.ExcelUtil;
import com.ruoyi.system.domain.SysConfig;
import com.ruoyi.system.service.ISysConfigService;
-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.*;
@@ -27,7 +26,7 @@
* @author Lion Li
*/
@Validated
-@Api(value = "鍙傛暟閰嶇疆鎺у埗鍣�", tags = {"鍙傛暟閰嶇疆绠＄悊"})
+@Tag(name ="鍙傛暟閰嶇疆鎺у埗鍣�", description = "鍙傛暟閰嶇疆绠＄悊")
@RequiredArgsConstructor
@RestController
@RequestMapping("/system/config")
@@ -38,14 +37,12 @@
/**
* 鑾峰彇鍙傛暟閰嶇疆鍒楄〃
*/
- @ApiOperation("鑾峰彇鍙傛暟閰嶇疆鍒楄〃")
@SaCheckPermission("system:config:list")
@GetMapping("/list")
public TableDataInfo<SysConfig> list(SysConfig config, PageQuery pageQuery) {
return configService.selectPageConfigList(config, pageQuery);
}
- @ApiOperation("瀵煎嚭鍙傛暟閰嶇疆鍒楄〃")
@Log(title = "鍙傛暟绠＄悊", businessType = BusinessType.EXPORT)
@SaCheckPermission("system:config:export")
@PostMapping("/export")
@@ -57,26 +54,23 @@
/**
* 鏍规嵁鍙傛暟缂栧彿鑾峰彇璇︾粏淇℃伅
*/
- @ApiOperation("鏍规嵁鍙傛暟缂栧彿鑾峰彇璇︾粏淇℃伅")
@SaCheckPermission("system:config:query")
@GetMapping(value = "/{configId}")
- public R<SysConfig> getInfo(@ApiParam("鍙傛暟ID") @PathVariable Long configId) {
+ public R<SysConfig> getInfo(@Parameter(name = "鍙傛暟ID") @PathVariable Long configId) {
return R.ok(configService.selectConfigById(configId));
}
/**
* 鏍规嵁鍙傛暟閿悕鏌ヨ鍙傛暟鍊�
*/
- @ApiOperation("鏍规嵁鍙傛暟閿悕鏌ヨ鍙傛暟鍊�")
@GetMapping(value = "/configKey/{configKey}")
- public R<Void> getConfigKey(@ApiParam("鍙傛暟Key") @PathVariable String configKey) {
+ public R<Void> getConfigKey(@Parameter(name = "鍙傛暟Key") @PathVariable String configKey) {
return R.ok(configService.selectConfigByKey(configKey));
}
/**
* 鏂板鍙傛暟閰嶇疆
*/
- @ApiOperation("鏂板鍙傛暟閰嶇疆")
@SaCheckPermission("system:config:add")
@Log(title = "鍙傛暟绠＄悊", businessType = BusinessType.INSERT)
@PostMapping
@@ -90,7 +84,6 @@
/**
* 淇敼鍙傛暟閰嶇疆
*/
- @ApiOperation("淇敼鍙傛暟閰嶇疆")
@SaCheckPermission("system:config:edit")
@Log(title = "鍙傛暟绠＄悊", businessType = BusinessType.UPDATE)
@PutMapping
@@ -104,7 +97,6 @@
/**
* 鏍规嵁鍙傛暟閿悕淇敼鍙傛暟閰嶇疆
*/
- @ApiOperation("鏍规嵁鍙傛暟閿悕淇敼鍙傛暟閰嶇疆")
@SaCheckPermission("system:config:edit")
@Log(title = "鍙傛暟绠＄悊", businessType = BusinessType.UPDATE)
@PutMapping("/updateByKey")
@@ -115,11 +107,10 @@
/**
* 鍒犻櫎鍙傛暟閰嶇疆
*/
- @ApiOperation("鍒犻櫎鍙傛暟閰嶇疆")
@SaCheckPermission("system:config:remove")
@Log(title = "鍙傛暟绠＄悊", businessType = BusinessType.DELETE)
@DeleteMapping("/{configIds}")
- public R<Void> remove(@ApiParam("鍙傛暟ID涓�") @PathVariable Long[] configIds) {
+ public R<Void> remove(@Parameter(name = "鍙傛暟ID涓�") @PathVariable Long[] configIds) {
configService.deleteConfigByIds(configIds);
return R.ok();
}
@@ -127,7 +118,6 @@
/**
* 鍒锋柊鍙傛暟缂撳瓨
*/
- @ApiOperation("鍒锋柊鍙傛暟缂撳瓨")
@SaCheckPermission("system:config:remove")
@Log(title = "鍙傛暟绠＄悊", businessType = BusinessType.CLEAN)
@DeleteMapping("/refreshCache")
--
Gitblit v1.9.3