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/MailController.java | 43 +++++++++++++++++--------------------------
1 files changed, 17 insertions(+), 26 deletions(-)
diff --git a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/MailController.java b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/MailController.java
index 53f130f..d86289d 100644
--- a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/MailController.java
+++ b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/MailController.java
@@ -2,9 +2,9 @@
import com.ruoyi.common.core.domain.R;
import com.ruoyi.common.utils.email.MailUtils;
-import io.swagger.annotations.Api;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
-import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
@@ -14,41 +14,32 @@
/**
- * 娴嬭瘯閭欢鍙戦�� Controller
+ * 閭欢鍙戦�佹渚�
*
* @author Michelle.Chung
*/
@Validated
-@Api(value = "閭欢鎺у埗鍣�", tags = {"娴嬭瘯閭欢鍙戦��"})
-@RequiredArgsConstructor(onConstructor_ = @Autowired)
-@RequestMapping("/demo/mail")
+@Tag(name ="閭欢鍙戦�佹渚�", description = "閭欢鍙戦�佹渚�")
+@RequiredArgsConstructor
@RestController
+@RequestMapping("/demo/mail")
public class MailController {
- /**
- * 鍙戦�侀偖浠�
- *
- * @param to 鎺ユ敹浜�
- * @param subject 鏍囬
- * @param text 鍐呭
- */
@GetMapping("/sendSimpleMessage")
- public R<Void> sendSimpleMessage(String to, String subject, String text) {
- MailUtils.send(to, subject, text, false);
- return R.ok("鎿嶄綔鎴愬姛");
+ public R<Void> sendSimpleMessage(@Parameter(name = "鎺ユ敹浜�") String to,
+ @Parameter(name = "鏍囬") String subject,
+ @Parameter(name = "鍐呭") String text) {
+ MailUtils.sendText(to, subject, text);
+ return R.ok();
}
- /**
- * 鍙戦�侀偖浠讹紙甯﹂檮浠讹級
- *
- * @param to 鎺ユ敹浜�
- * @param subject 鏍囬
- * @param text 鍐呭
- */
@GetMapping("/sendMessageWithAttachment")
- public R<Void> sendMessageWithAttachment(String to, String subject, String text, String filePath) {
- MailUtils.send(to, subject, text, false, new File(filePath));
- return R.ok("鎿嶄綔鎴愬姛");
+ public R<Void> sendMessageWithAttachment(@Parameter(name = "鎺ユ敹浜�") String to,
+ @Parameter(name = "鏍囬") String subject,
+ @Parameter(name = "鍐呭") String text,
+ @Parameter(name = "闄勪欢璺緞") String filePath) {
+ MailUtils.sendText(to, subject, text, new File(filePath));
+ return R.ok();
}
}
--
Gitblit v1.9.3