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/DelayedQueueController.java | 37 ++++++++++++++++---------------------
1 files changed, 16 insertions(+), 21 deletions(-)
diff --git a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/queue/DelayedQueueController.java b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/queue/DelayedQueueController.java
index 77ee268..0abcc4b 100644
--- a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/queue/DelayedQueueController.java
+++ b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/queue/DelayedQueueController.java
@@ -1,10 +1,9 @@
package com.ruoyi.demo.controller.queue;
-import com.ruoyi.common.core.domain.AjaxResult;
+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;
@@ -26,53 +25,49 @@
* @version 3.6.0
*/
@Slf4j
-@Api(value = "寤惰繜闃熷垪 婕旂ず妗堜緥", tags = {"寤惰繜闃熷垪"})
+@Tag(name ="寤惰繜闃熷垪 婕旂ず妗堜緥", description = "寤惰繜闃熷垪")
@RequiredArgsConstructor
@RestController
@RequestMapping("/demo/queue/delayed")
public class DelayedQueueController {
- @ApiOperation("璁㈤槄闃熷垪")
@GetMapping("/subscribe")
- public AjaxResult<Void> subscribe(@ApiParam("闃熷垪鍚�") String queueName) {
+ public R<Void> subscribe(@Parameter(name = "闃熷垪鍚�") String queueName) {
log.info("閫氶亾: {} 鐩戝惉涓�......", queueName);
// 椤圭洰鍒濆鍖栬缃竴娆″嵆鍙�
QueueUtils.subscribeBlockingQueue(queueName, (String orderNum) -> {
// 瑙傚療鎺ユ敹鏃堕棿
log.info("閫氶亾: {}, 鏀跺埌鏁版嵁: {}", queueName, orderNum);
});
- return AjaxResult.success("鎿嶄綔鎴愬姛");
+ return R.ok("鎿嶄綔鎴愬姛");
}
- @ApiOperation("娣诲姞闃熷垪鏁版嵁")
@GetMapping("/add")
- public AjaxResult<Void> add(@ApiParam("闃熷垪鍚�") String queueName,
- @ApiParam("璁㈠崟鍙�") String orderNum,
- @ApiParam("寤惰繜鏃堕棿(绉�)") Long time) {
+ public R<Void> add(@Parameter(name = "闃熷垪鍚�") String queueName,
+ @Parameter(name = "璁㈠崟鍙�") String orderNum,
+ @Parameter(name = "寤惰繜鏃堕棿(绉�)") Long time) {
QueueUtils.addDelayedQueueObject(queueName, orderNum, time, TimeUnit.SECONDS);
// 瑙傚療鍙戦�佹椂闂�
log.info("閫氶亾: {} , 鍙戦�佹暟鎹�: {}", queueName, orderNum);
- return AjaxResult.success("鎿嶄綔鎴愬姛");
+ return R.ok("鎿嶄綔鎴愬姛");
}
- @ApiOperation("鍒犻櫎闃熷垪鏁版嵁")
@GetMapping("/remove")
- public AjaxResult<Void> remove(@ApiParam("闃熷垪鍚�") String queueName,
- @ApiParam("璁㈠崟鍙�") String orderNum) {
+ public R<Void> remove(@Parameter(name = "闃熷垪鍚�") String queueName,
+ @Parameter(name = "璁㈠崟鍙�") String orderNum) {
if (QueueUtils.removeDelayedQueueObject(queueName, orderNum)) {
log.info("閫氶亾: {} , 鍒犻櫎鏁版嵁: {}", queueName, orderNum);
} else {
- return AjaxResult.error("鎿嶄綔澶辫触");
+ return R.fail("鎿嶄綔澶辫触");
}
- return AjaxResult.success("鎿嶄綔鎴愬姛");
+ return R.ok("鎿嶄綔鎴愬姛");
}
- @ApiOperation("閿�姣侀槦鍒�")
@GetMapping("/destroy")
- public AjaxResult<Void> destroy(@ApiParam("闃熷垪鍚�") String queueName) {
+ public R<Void> destroy(@Parameter(name = "闃熷垪鍚�") String queueName) {
// 鐢ㄥ畬浜嗕竴瀹氳閿�姣� 鍚﹀垯浼氫竴鐩村瓨鍦�
QueueUtils.destroyDelayedQueue(queueName);
- return AjaxResult.success("鎿嶄綔鎴愬姛");
+ return R.ok("鎿嶄綔鎴愬姛");
}
}
--
Gitblit v1.9.3