From fd8affdc8a8575ca1445faee39c38ee507b8c5a1 Mon Sep 17 00:00:00 2001
From: 疯狂的狮子li <15040126243@163.com>
Date: 星期五, 03 九月 2021 16:21:23 +0800
Subject: [PATCH] update 补全演示案例 接口文档
---
ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestI18nController.java | 4 ++++
ruoyi-demo/src/main/java/com/ruoyi/demo/controller/RedisCacheController.java | 6 ++++++
ruoyi-demo/src/main/java/com/ruoyi/demo/controller/FeignTestController.java | 7 +++++++
ruoyi-demo/src/main/java/com/ruoyi/demo/controller/RedisLockController.java | 6 ++++++
4 files changed, 23 insertions(+), 0 deletions(-)
diff --git a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/FeignTestController.java b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/FeignTestController.java
index ec3e0d6..f8bec9f 100644
--- a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/FeignTestController.java
+++ b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/FeignTestController.java
@@ -2,6 +2,8 @@
import com.ruoyi.common.core.domain.AjaxResult;
import com.ruoyi.demo.feign.FeignTestService;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
import lombok.RequiredArgsConstructor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
@@ -14,6 +16,7 @@
*
* @author Lion Li
*/
+@Api(value = "feign娴嬭瘯", tags = {"feign娴嬭瘯"})
@RequiredArgsConstructor(onConstructor_ = @Autowired)
@RestController
@RequestMapping("/feign/test")
@@ -21,6 +24,10 @@
private final FeignTestService feignTestService;
+ /**
+ * 鎼滅储鏁版嵁
+ */
+ @ApiOperation("娴嬭瘯浣跨敤feign璇锋眰鏁版嵁")
@GetMapping("/search/{wd}")
public AjaxResult search(@PathVariable String wd) {
String search = feignTestService.search(wd);
diff --git a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/RedisCacheController.java b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/RedisCacheController.java
index 4588f13..6877aed 100644
--- a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/RedisCacheController.java
+++ b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/RedisCacheController.java
@@ -1,6 +1,8 @@
package com.ruoyi.demo.controller;
import com.ruoyi.common.core.domain.AjaxResult;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
import lombok.RequiredArgsConstructor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.cache.annotation.CacheEvict;
@@ -17,6 +19,7 @@
*/
// 绫荤骇鍒� 缂撳瓨缁熶竴閰嶇疆
//@CacheConfig(cacheNames = "redissonCacheMap")
+@Api(value = "spring-cache 婕旂ず妗堜緥", tags = {"spring-cache 婕旂ず妗堜緥"})
@RequiredArgsConstructor(onConstructor_ = @Autowired)
@RestController
@RequestMapping("/demo/cache")
@@ -33,6 +36,7 @@
*
* cacheNames 涓洪厤缃枃浠跺唴 groupId
*/
+ @ApiOperation("娴嬭瘯 @Cacheable")
@Cacheable(cacheNames = "redissonCacheMap", key = "#key", condition = "#key != null")
@GetMapping("/test1")
public AjaxResult<String> test1(String key, String value){
@@ -47,6 +51,7 @@
*
* cacheNames 涓� 閰嶇疆鏂囦欢鍐� groupId
*/
+ @ApiOperation("娴嬭瘯 @CachePut")
@CachePut(cacheNames = "redissonCacheMap", key = "#key", condition = "#key != null")
@GetMapping("/test2")
public AjaxResult<String> test2(String key, String value){
@@ -61,6 +66,7 @@
*
* cacheNames 涓� 閰嶇疆鏂囦欢鍐� groupId
*/
+ @ApiOperation("娴嬭瘯 @CacheEvict")
@CacheEvict(cacheNames = "redissonCacheMap", key = "#key", condition = "#key != null")
@GetMapping("/test3")
public AjaxResult<String> test3(String key, String value){
diff --git a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/RedisLockController.java b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/RedisLockController.java
index f6649ed..a720246 100644
--- a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/RedisLockController.java
+++ b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/RedisLockController.java
@@ -5,6 +5,8 @@
import com.baomidou.lock.annotation.Lock4j;
import com.baomidou.lock.executor.RedissonLockExecutor;
import com.ruoyi.common.core.domain.AjaxResult;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.cache.annotation.Cacheable;
@@ -20,6 +22,7 @@
*
* @author shenxinquan
*/
+@Api(value = "娴嬭瘯鍒嗗竷寮忛攣鐨勬牱渚�", tags = {"娴嬭瘯鍒嗗竷寮忛攣鐨勬牱渚�"})
@Slf4j
@RestController
@RequestMapping("/demo/redisLock")
@@ -31,6 +34,7 @@
/**
* 娴嬭瘯lock4j 娉ㄨВ
*/
+ @ApiOperation("娴嬭瘯lock4j 娉ㄨВ")
@Lock4j(keys = {"#key"})
@GetMapping("/testLock4j")
public AjaxResult<String> testLock4j(String key,String value){
@@ -47,6 +51,7 @@
/**
* 娴嬭瘯lock4j 宸ュ叿
*/
+ @ApiOperation("娴嬭瘯lock4j 宸ュ叿")
@GetMapping("/testLock4jLockTemaplate")
public AjaxResult<String> testLock4jLockTemaplate(String key,String value){
final LockInfo lockInfo = lockTemplate.lock(key, 30000L, 5000L, RedissonLockExecutor.class);
@@ -72,6 +77,7 @@
/**
* 娴嬭瘯spring-cache娉ㄨВ
*/
+ @ApiOperation("娴嬭瘯spring-cache娉ㄨВ")
@Cacheable(value = "test", key = "#key")
@GetMapping("/testCache")
public AjaxResult<String> testCache(String key) {
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 8ccce2a..bb0695f 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
@@ -2,6 +2,8 @@
import com.ruoyi.common.core.domain.AjaxResult;
import com.ruoyi.common.utils.MessageUtils;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@@ -12,6 +14,7 @@
*
* @author Lion Li
*/
+@Api(value = "娴嬭瘯鍥介檯鍖栨帶鍒跺櫒", tags = {"娴嬭瘯鍥介檯鍖栫鐞�"})
@RestController
@RequestMapping("/demo/i18n")
public class TestI18nController {
@@ -22,6 +25,7 @@
*
* 娴嬭瘯浣跨敤 user.register.success
*/
+ @ApiOperation("閫氳繃code鑾峰彇鍥介檯鍖栧唴瀹�")
@GetMapping()
public AjaxResult<Void> get(String code) {
return AjaxResult.success(MessageUtils.message(code));
--
Gitblit v1.9.3