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-demo/src/main/java/com/ruoyi/demo/controller/queue/BoundedQueueController.java | 18 +++++++-----------
1 files changed, 7 insertions(+), 11 deletions(-)
diff --git a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/queue/BoundedQueueController.java b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/queue/BoundedQueueController.java
index 532c499..a940c2c 100644
--- a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/queue/BoundedQueueController.java
+++ b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/queue/BoundedQueueController.java
@@ -2,9 +2,8 @@
import com.ruoyi.common.core.domain.R;
import com.ruoyi.common.utils.redis.QueueUtils;
-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 lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
@@ -23,17 +22,16 @@
* @version 3.6.0
*/
@Slf4j
-@Api(value = "鏈夌晫闃熷垪 婕旂ず妗堜緥", tags = {"鏈夌晫闃熷垪"})
+@Tag(name ="鏈夌晫闃熷垪 婕旂ず妗堜緥", description = "鏈夌晫闃熷垪")
@RequiredArgsConstructor
@RestController
@RequestMapping("/demo/queue/bounded")
public class BoundedQueueController {
- @ApiOperation("娣诲姞闃熷垪鏁版嵁")
@GetMapping("/add")
- public R<Void> add(@ApiParam("闃熷垪鍚�") String queueName,
- @ApiParam("瀹归噺") int capacity) {
+ public R<Void> add(@Parameter(name = "闃熷垪鍚�") String queueName,
+ @Parameter(name = "瀹归噺") int capacity) {
// 鐢ㄥ畬浜嗕竴瀹氳閿�姣� 鍚﹀垯浼氫竴鐩村瓨鍦�
boolean b = QueueUtils.destroyBoundedQueueObject(queueName);
log.info("閫氶亾: {} , 鍒犻櫎: {}", queueName, b);
@@ -56,9 +54,8 @@
return R.ok("鎿嶄綔鎴愬姛");
}
- @ApiOperation("鍒犻櫎闃熷垪鏁版嵁")
@GetMapping("/remove")
- public R<Void> remove(@ApiParam("闃熷垪鍚�") String queueName) {
+ public R<Void> remove(@Parameter(name = "闃熷垪鍚�") String queueName) {
String data = "data-" + 5;
if (QueueUtils.removeBoundedQueueObject(queueName, data)) {
log.info("閫氶亾: {} , 鍒犻櫎鏁版嵁: {}", queueName, data);
@@ -68,9 +65,8 @@
return R.ok("鎿嶄綔鎴愬姛");
}
- @ApiOperation("鑾峰彇闃熷垪鏁版嵁")
@GetMapping("/get")
- public R<Void> get(@ApiParam("闃熷垪鍚�") String queueName) {
+ public R<Void> get(@Parameter(name = "闃熷垪鍚�") String queueName) {
String data;
do {
data = QueueUtils.getBoundedQueueObject(queueName);
--
Gitblit v1.9.3