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/TestSensitiveController.java | 109 +++++++++++++++++++++++++++++------------------------- 1 files changed, 59 insertions(+), 50 deletions(-) diff --git a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestSensitiveController.java b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestSensitiveController.java index 30708cd..9b7f34a 100644 --- a/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestSensitiveController.java +++ b/ruoyi-demo/src/main/java/com/ruoyi/demo/controller/TestSensitiveController.java @@ -1,68 +1,77 @@ package com.ruoyi.demo.controller; -import cn.hutool.core.bean.BeanUtil; -import com.ruoyi.common.annotation.Log; -import com.ruoyi.common.annotation.RepeatSubmit; +import com.ruoyi.common.annotation.Sensitive; import com.ruoyi.common.core.controller.BaseController; -import com.ruoyi.common.core.domain.AjaxResult; -import com.ruoyi.common.core.domain.PageQuery; -import com.ruoyi.common.core.page.TableDataInfo; -import com.ruoyi.common.core.validate.AddGroup; -import com.ruoyi.common.core.validate.EditGroup; -import com.ruoyi.common.core.validate.QueryGroup; -import com.ruoyi.common.enums.BusinessType; -import com.ruoyi.common.excel.ExcelResult; -import com.ruoyi.common.utils.ValidatorUtils; -import com.ruoyi.common.utils.poi.ExcelUtil; -import com.ruoyi.demo.domain.TestDemo; -import com.ruoyi.demo.domain.TestSensitive; -import com.ruoyi.demo.domain.bo.TestDemoBo; -import com.ruoyi.demo.domain.bo.TestDemoImportVo; -import com.ruoyi.demo.domain.vo.TestDemoVo; -import com.ruoyi.demo.service.ITestDemoService; -import io.swagger.annotations.*; -import lombok.RequiredArgsConstructor; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.security.access.prepost.PreAuthorize; -import org.springframework.validation.annotation.Validated; -import org.springframework.web.bind.annotation.*; -import org.springframework.web.multipart.MultipartFile; - -import javax.servlet.http.HttpServletResponse; -import javax.validation.constraints.NotEmpty; -import javax.validation.constraints.NotNull; -import java.util.Arrays; -import java.util.List; -import java.util.concurrent.TimeUnit; +import com.ruoyi.common.core.domain.R; +import com.ruoyi.common.enums.SensitiveStrategy; +import io.swagger.v3.oas.annotations.tags.Tag; +import lombok.Data; +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RestController; /** - * 娴嬭瘯鍗曡〃Controller + * 娴嬭瘯鏁版嵁鑴辨晱鎺у埗鍣� + * <p> + * 榛樿绠$悊鍛樹笉杩囨护 + * 闇�鑷鏍规嵁涓氬姟閲嶅啓瀹炵幇 * * @author Lion Li - * @date 2021-07-26 + * @version 3.6.0 + * @see com.ruoyi.common.core.service.SensitiveService */ -@Validated -@Api(value = "娴嬭瘯鏁版嵁鑴辨晱鎺у埗鍣�", tags = {"娴嬭瘯鏁版嵁鑴辨晱绠$悊"}) -@RequiredArgsConstructor(onConstructor_ = @Autowired) +@Tag(name ="娴嬭瘯鏁版嵁鑴辨晱鎺у埗鍣�", description = "娴嬭瘯鏁版嵁鑴辨晱绠$悊") @RestController @RequestMapping("/demo/sensitive") public class TestSensitiveController extends BaseController { - //榛樿涓篴dmin鐢ㄦ埛鍙婃嫢鏈塖ensitive鏉冮檺瀛楃鐢ㄦ埛涓嶅仛鑴辨晱 - //1.閰嶇疆鑿滃崟鍔犲叆鏉冮檺瀛楃涓篠ensitive鐨勬寜閽� - //2.閰嶇疆闇�瑕佸厤闄ゆ暟鎹劚鏁忕殑瑙掕壊鍔犲叆Sensitive鏉冮檺 - //3.瀹炰綋绫讳笂鍔犱笂鏁版嵁鑴辨晱娉ㄨВ /** * 娴嬭瘯鏁版嵁鑴辨晱 */ - @ApiOperation("鏌ヨ娴嬭瘯鍗曡〃鍒楄〃") - @GetMapping() - public AjaxResult<TestSensitive> get() { - TestSensitive testSensitive = new TestSensitive() - .setIdCard("3333199910101212") - .setPhone("18888888888") - .setAddress("鍖椾含甯傛湞闃冲尯鏌愭煇鍥涘悎闄�1203瀹�"); - return AjaxResult.success(testSensitive); + @GetMapping("/test") + public R<TestSensitive> test() { + TestSensitive testSensitive = new TestSensitive(); + testSensitive.setIdCard("210397198608215431"); + testSensitive.setPhone("17640125371"); + testSensitive.setAddress("鍖椾含甯傛湞闃冲尯鏌愭煇鍥涘悎闄�1203瀹�"); + testSensitive.setEmail("17640125371@163.com"); + testSensitive.setBankCard("6226456952351452853"); + return R.ok(testSensitive); + } + + @Data + static class TestSensitive { + + /** + * 韬唤璇� + */ + @Sensitive(strategy = SensitiveStrategy.ID_CARD) + private String idCard; + + /** + * 鐢佃瘽 + */ + @Sensitive(strategy = SensitiveStrategy.PHONE) + private String phone; + + /** + * 鍦板潃 + */ + @Sensitive(strategy = SensitiveStrategy.ADDRESS) + private String address; + + /** + * 閭 + */ + @Sensitive(strategy = SensitiveStrategy.EMAIL) + private String email; + + /** + * 閾惰鍗� + */ + @Sensitive(strategy = SensitiveStrategy.BANK_CARD) + private String bankCard; + } } -- Gitblit v1.9.3