From a6fb88d74c20cc28043d75e8a5097fce49cf9a78 Mon Sep 17 00:00:00 2001
From: 疯狂的狮子li <15040126243@163.com>
Date: 星期五, 15 十月 2021 15:19:42 +0800
Subject: [PATCH] update [重大更新]全业务 增加 接口文档注解 格式化代码

---
 ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysDictDataController.java |   52 +++++++++++++++++++++++++++-------------------------
 1 files changed, 27 insertions(+), 25 deletions(-)

diff --git a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysDictDataController.java b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysDictDataController.java
index 6462a0c..fca1a20 100644
--- a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysDictDataController.java
+++ b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysDictDataController.java
@@ -10,6 +10,9 @@
 import com.ruoyi.common.utils.poi.ExcelUtil;
 import com.ruoyi.system.service.ISysDictDataService;
 import com.ruoyi.system.service.ISysDictTypeService;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
+import lombok.RequiredArgsConstructor;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.validation.annotation.Validated;
@@ -22,54 +25,53 @@
 /**
  * 鏁版嵁瀛楀吀淇℃伅
  *
- * @author ruoyi
+ * @author Lion Li
  */
+@Validated
+@Api(value = "鏁版嵁瀛楀吀淇℃伅鎺у埗鍣�", tags = {"鏁版嵁瀛楀吀淇℃伅绠＄悊"})
+@RequiredArgsConstructor(onConstructor_ = @Autowired)
 @RestController
 @RequestMapping("/system/dict/data")
-public class SysDictDataController extends BaseController
-{
-    @Autowired
-    private ISysDictDataService dictDataService;
+public class SysDictDataController extends BaseController {
 
-    @Autowired
-    private ISysDictTypeService dictTypeService;
+    private final ISysDictDataService dictDataService;
+    private final ISysDictTypeService dictTypeService;
 
+    @ApiOperation("鏌ヨ瀛楀吀鏁版嵁鍒楄〃")
     @PreAuthorize("@ss.hasPermi('system:dict:list')")
     @GetMapping("/list")
-    public TableDataInfo list(SysDictData dictData)
-    {
+    public TableDataInfo<SysDictData> list(SysDictData dictData) {
         return dictDataService.selectPageDictDataList(dictData);
     }
 
+    @ApiOperation("瀵煎嚭瀛楀吀鏁版嵁鍒楄〃")
     @Log(title = "瀛楀吀鏁版嵁", businessType = BusinessType.EXPORT)
     @PreAuthorize("@ss.hasPermi('system:dict:export')")
     @GetMapping("/export")
-    public void export(SysDictData dictData, HttpServletResponse response)
-    {
+    public void export(SysDictData dictData, HttpServletResponse response) {
         List<SysDictData> list = dictDataService.selectDictDataList(dictData);
-		ExcelUtil.exportExcel(list, "瀛楀吀鏁版嵁", SysDictData.class, response);
+        ExcelUtil.exportExcel(list, "瀛楀吀鏁版嵁", SysDictData.class, response);
     }
 
     /**
      * 鏌ヨ瀛楀吀鏁版嵁璇︾粏
      */
+    @ApiOperation("鏌ヨ瀛楀吀鏁版嵁璇︾粏")
     @PreAuthorize("@ss.hasPermi('system:dict:query')")
     @GetMapping(value = "/{dictCode}")
-    public AjaxResult getInfo(@PathVariable Long dictCode)
-    {
+    public AjaxResult<SysDictData> getInfo(@PathVariable Long dictCode) {
         return AjaxResult.success(dictDataService.selectDictDataById(dictCode));
     }
 
     /**
      * 鏍规嵁瀛楀吀绫诲瀷鏌ヨ瀛楀吀鏁版嵁淇℃伅
      */
+    @ApiOperation("鏍规嵁瀛楀吀绫诲瀷鏌ヨ瀛楀吀鏁版嵁淇℃伅")
     @GetMapping(value = "/type/{dictType}")
-    public AjaxResult dictType(@PathVariable String dictType)
-    {
+    public AjaxResult<List<SysDictData>> dictType(@PathVariable String dictType) {
         List<SysDictData> data = dictTypeService.selectDictDataByType(dictType);
-        if (StringUtils.isNull(data))
-        {
-            data = new ArrayList<SysDictData>();
+        if (StringUtils.isNull(data)) {
+            data = new ArrayList<>();
         }
         return AjaxResult.success(data);
     }
@@ -77,11 +79,11 @@
     /**
      * 鏂板瀛楀吀绫诲瀷
      */
+    @ApiOperation("鏂板瀛楀吀绫诲瀷")
     @PreAuthorize("@ss.hasPermi('system:dict:add')")
     @Log(title = "瀛楀吀鏁版嵁", businessType = BusinessType.INSERT)
     @PostMapping
-    public AjaxResult add(@Validated @RequestBody SysDictData dict)
-    {
+    public AjaxResult<Void> add(@Validated @RequestBody SysDictData dict) {
         dict.setCreateBy(getUsername());
         return toAjax(dictDataService.insertDictData(dict));
     }
@@ -89,11 +91,11 @@
     /**
      * 淇敼淇濆瓨瀛楀吀绫诲瀷
      */
+    @ApiOperation("淇敼淇濆瓨瀛楀吀绫诲瀷")
     @PreAuthorize("@ss.hasPermi('system:dict:edit')")
     @Log(title = "瀛楀吀鏁版嵁", businessType = BusinessType.UPDATE)
     @PutMapping
-    public AjaxResult edit(@Validated @RequestBody SysDictData dict)
-    {
+    public AjaxResult<Void> edit(@Validated @RequestBody SysDictData dict) {
         dict.setUpdateBy(getUsername());
         return toAjax(dictDataService.updateDictData(dict));
     }
@@ -101,11 +103,11 @@
     /**
      * 鍒犻櫎瀛楀吀绫诲瀷
      */
+    @ApiOperation("鍒犻櫎瀛楀吀绫诲瀷")
     @PreAuthorize("@ss.hasPermi('system:dict:remove')")
     @Log(title = "瀛楀吀绫诲瀷", businessType = BusinessType.DELETE)
     @DeleteMapping("/{dictCodes}")
-    public AjaxResult remove(@PathVariable Long[] dictCodes)
-    {
+    public AjaxResult<Void> remove(@PathVariable Long[] dictCodes) {
         dictDataService.deleteDictDataByIds(dictCodes);
         return success();
     }

--
Gitblit v1.9.3