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/TestI18nController.java | 69 +++++++++++++++++++++++++++-------
1 files changed, 54 insertions(+), 15 deletions(-)
diff --git a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestI18nController.java b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestI18nController.java
index bb0695f..a004463 100644
--- a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestI18nController.java
+++ b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestI18nController.java
@@ -1,12 +1,18 @@
package com.ruoyi.demo.controller;
-import com.ruoyi.common.core.domain.AjaxResult;
+import com.ruoyi.common.core.domain.R;
import com.ruoyi.common.utils.MessageUtils;
-import io.swagger.annotations.Api;
-import io.swagger.annotations.ApiOperation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.tags.Tag;
+import lombok.Data;
+import org.hibernate.validator.constraints.Range;
+import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
+
+import javax.validation.constraints.NotBlank;
+import javax.validation.constraints.NotNull;
/**
@@ -14,20 +20,53 @@
*
* @author Lion Li
*/
-@Api(value = "娴嬭瘯鍥介檯鍖栨帶鍒跺櫒", tags = {"娴嬭瘯鍥介檯鍖栫鐞�"})
+@Validated
+@Tag(name ="娴嬭瘯鍥介檯鍖栨帶鍒跺櫒", description = "娴嬭瘯鍥介檯鍖栫鐞�")
@RestController
@RequestMapping("/demo/i18n")
public class TestI18nController {
- /**
- * 閫氳繃code鑾峰彇鍥介檯鍖栧唴瀹�
- * code涓� messages.properties 涓殑 key
- *
- * 娴嬭瘯浣跨敤 user.register.success
- */
- @ApiOperation("閫氳繃code鑾峰彇鍥介檯鍖栧唴瀹�")
- @GetMapping()
- public AjaxResult<Void> get(String code) {
- return AjaxResult.success(MessageUtils.message(code));
- }
+ /**
+ * 閫氳繃code鑾峰彇鍥介檯鍖栧唴瀹�
+ * code涓� messages.properties 涓殑 key
+ * <p>
+ * 娴嬭瘯浣跨敤 user.register.success
+ */
+ @GetMapping()
+ public R<Void> get(@Parameter(name = "鍥介檯鍖朿ode") String code) {
+ return R.ok(MessageUtils.message(code));
+ }
+
+ /**
+ * Validator 鏍￠獙鍥介檯鍖�
+ * 涓嶄紶鍊� 鍒嗗埆鏌ョ湅寮傚父杩斿洖
+ * <p>
+ * 娴嬭瘯浣跨敤 not.null
+ */
+ @GetMapping("/test1")
+ public R<Void> test1(@NotBlank(message = "{not.null}") String str) {
+ return R.ok(str);
+ }
+
+ /**
+ * Bean 鏍￠獙鍥介檯鍖�
+ * 涓嶄紶鍊� 鍒嗗埆鏌ョ湅寮傚父杩斿洖
+ * <p>
+ * 娴嬭瘯浣跨敤 not.null
+ */
+ @GetMapping("/test2")
+ public R<TestI18nBo> test2(@Validated TestI18nBo bo) {
+ return R.ok(bo);
+ }
+
+ @Data
+ public static class TestI18nBo {
+
+ @NotBlank(message = "{not.null}")
+ private String name;
+
+ @NotNull(message = "{not.null}")
+ @Range(min = 0, max = 100, message = "{length.not.valid}")
+ private Integer age;
+ }
}
--
Gitblit v1.9.3