feat: 添加字典接口文档

shuili-admin/src/main/java/com/kms/web/controller/system/SysDictDataController.java

@@ -1,5 +1,8 @@
 package com.kms.web.controller.system;
 
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiOperation;
 import java.util.List;
 
 import cn.dev33.satoken.annotation.SaCheckLogin;
@@ -34,6 +37,7 @@ import cn.dev33.satoken.annotation.SaCheckPermission;
  */
 @RestController
 @RequestMapping("/system/dict/data")
+@Api(tags = "字典数据")
 public class SysDictDataController extends BaseController
 {
     @Autowired
@@ -41,7 +45,7 @@ public class SysDictDataController extends BaseController
 
     @Autowired
     private SysDictTypeService dictTypeService;
-
+    @ApiOperation("字典数据列表")
     @SaCheckLogin
     @SaCheckPermission(value = "system:dict:list")
     @PostMapping("/list")
@@ -66,6 +70,8 @@ public class SysDictDataController extends BaseController
     /**
      * 查询字典数据详细
      */
+
+    @ApiOperation("字典数据详情")
     @SaCheckLogin
     @GetMapping(value = "/{dictCode}")
     @SaCheckPermission(value = "system:dict:query")
@@ -77,6 +83,7 @@ public class SysDictDataController extends BaseController
     /**
      * 根据字典类型查询字典数据信息
      */
+    @ApiOperation("根据字典类型查询字典数据信息")
     @GetMapping(value = "/type/{dictType}")
     public AjaxResult dictType(@PathVariable String dictType)
     {

shuili-admin/src/main/java/com/kms/web/controller/system/SysDictTypeController.java

@@ -1,13 +1,22 @@
 package com.kms.web.controller.system;
 
-import java.util.Arrays;
-import java.util.List;
-
 import cn.dev33.satoken.annotation.SaCheckLogin;
+import cn.dev33.satoken.annotation.SaCheckPermission;
 import com.baomidou.mybatisplus.core.metadata.IPage;
-import com.shuili.common.core.domain.SearchParam;
 import com.kms.common.utils.BaseEntityUtils;
 import com.kms.system.service.SysDictTypeService;
+import com.shuili.common.annotation.Log;
+import com.shuili.common.constant.UserConstants;
+import com.shuili.common.core.controller.BaseController;
+import com.shuili.common.core.domain.AjaxResult;
+import com.shuili.common.core.domain.SearchParam;
+import com.shuili.common.core.domain.entity.SysDictType;
+import com.shuili.common.enums.BusinessType;
+import com.shuili.common.utils.poi.ExcelUtil;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
+import java.util.Arrays;
+import java.util.List;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.validation.annotation.Validated;
 import org.springframework.web.bind.annotation.DeleteMapping;
@@ -19,16 +28,6 @@ import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
-import com.shuili.common.annotation.Log;
-import com.shuili.common.constant.UserConstants;
-import com.shuili.common.core.controller.BaseController;
-import com.shuili.common.core.domain.AjaxResult;
-import com.shuili.common.core.domain.entity.SysDictType;
-import com.shuili.common.enums.BusinessType;
-import com.shuili.common.utils.poi.ExcelUtil;
-
-import cn.dev33.satoken.annotation.SaCheckPermission;
-
 /**
  * 数据字典信息
  *
@@ -36,116 +35,111 @@ import cn.dev33.satoken.annotation.SaCheckPermission;
  */
 @RestController
 @RequestMapping("/system/dict/type")
-public class SysDictTypeController extends BaseController
-{
-    @Autowired
-    private SysDictTypeService dictTypeService;
+@Api(tags = "字典类型")
+public class SysDictTypeController extends BaseController {
+
+  @Autowired
+  private SysDictTypeService dictTypeService;
 
-    @SaCheckLogin
-    @PostMapping("/list")
-    @SaCheckPermission(value = "system:dict:list")
-    public IPage list(@RequestBody SearchParam<SysDictType> dictType)
-    {
+
+  @ApiOperation("字典类型列表")
+  @SaCheckLogin
+  @PostMapping("/list")
+  @SaCheckPermission(value = "system:dict:list")
+  public IPage list(@RequestBody SearchParam<SysDictType> dictType) {
 //        startPage();
 //        List<SysDictType> list = dictTypeService.selectDictTypeList(dictType);
-        dictType.addParam(SearchParam.SORT_BY,"desc");
-        dictType.addParam(SearchParam.ORDER_BY,"update_time");
-        return dictTypeService.selectPage(dictType);
-    }
+    dictType.addParam(SearchParam.SORT_BY, "desc");
+    dictType.addParam(SearchParam.ORDER_BY, "update_time");
+    return dictTypeService.selectPage(dictType);
+  }
 
-    @GetMapping("allList")
-    public AjaxResult allList(){
-        return AjaxResult.success(dictTypeService.list());
-    }
+  @ApiOperation("获取所有的字典类型")
+  @GetMapping("allList")
+  public AjaxResult allList() {
+    return AjaxResult.success(dictTypeService.list());
+  }
 
-    @SaCheckLogin
-    @Log(title = "字典类型", businessType = BusinessType.EXPORT)
-    @SaCheckPermission(value = "system:dict:export")
-    @GetMapping("/export")
-    public AjaxResult export(SysDictType dictType)
-    {
-        List<SysDictType> list = dictTypeService.selectDictTypeList(dictType);
-        ExcelUtil<SysDictType> util = new ExcelUtil<SysDictType>(SysDictType.class);
-        return util.exportExcel(list, "字典类型");
-    }
+  @SaCheckLogin
+  @Log(title = "字典类型", businessType = BusinessType.EXPORT)
+  @SaCheckPermission(value = "system:dict:export")
+  @GetMapping("/export")
+  public AjaxResult export(SysDictType dictType) {
+    List<SysDictType> list = dictTypeService.selectDictTypeList(dictType);
+    ExcelUtil<SysDictType> util = new ExcelUtil<SysDictType>(SysDictType.class);
+    return util.exportExcel(list, "字典类型");
+  }
 
-    /**
-     * 查询字典类型详细
-     */
-    @SaCheckLogin
-    @GetMapping(value = "/{dictId}")
-    @SaCheckPermission(value = "system:dict:query")
-    public AjaxResult getInfo(@PathVariable String dictId)
-    {
-        return AjaxResult.success(dictTypeService.selectDictTypeById(dictId));
-    }
+  /**
+   * 查询字典类型详细
+   */
+  @ApiOperation("字典类型详情")
+  @SaCheckLogin
+  @GetMapping(value = "/{dictId}")
+  @SaCheckPermission(value = "system:dict:query")
+  public AjaxResult getInfo(@PathVariable String dictId) {
+    return AjaxResult.success(dictTypeService.selectDictTypeById(dictId));
+  }
 
-    /**
-     * 新增字典类型
-     */
-    @SaCheckLogin
-    @Log(title = "字典类型", businessType = BusinessType.INSERT)
-    @SaCheckPermission(value = "system:dict:add")
-    @PostMapping
-    public AjaxResult add(@Validated @RequestBody SysDictType dict)
-    {
-        if (UserConstants.NOT_UNIQUE.equals(dictTypeService.checkDictTypeUnique(dict)))
-        {
-            return AjaxResult.error("新增字典'" + dict.getDictName() + "'失败，字典类型已存在");
-        }
-        BaseEntityUtils.preInsert(dict);
-        return toAjax(dictTypeService.save(dict));
+  /**
+   * 新增字典类型
+   */
+  @SaCheckLogin
+  @Log(title = "字典类型", businessType = BusinessType.INSERT)
+  @SaCheckPermission(value = "system:dict:add")
+  @PostMapping
+  public AjaxResult add(@Validated @RequestBody SysDictType dict) {
+    if (UserConstants.NOT_UNIQUE.equals(dictTypeService.checkDictTypeUnique(dict))) {
+      return AjaxResult.error("新增字典'" + dict.getDictName() + "'失败，字典类型已存在");
     }
+    BaseEntityUtils.preInsert(dict);
+    return toAjax(dictTypeService.save(dict));
+  }
 
-    /**
-     * 修改字典类型
-     */
-    @SaCheckLogin
-    @Log(title = "字典类型", businessType = BusinessType.UPDATE)
-    @SaCheckPermission(value = "system:dict:edit")
-    @PutMapping
-    public AjaxResult edit(@Validated @RequestBody SysDictType dict)
-    {
-        if (UserConstants.NOT_UNIQUE.equals(dictTypeService.checkDictTypeUnique(dict)))
-        {
-            return AjaxResult.error("修改字典'" + dict.getDictName() + "'失败，字典类型已存在");
-        }
-        BaseEntityUtils.preUpdate(dict);
-        return toAjax(dictTypeService.updateById(dict));
+  /**
+   * 修改字典类型
+   */
+  @SaCheckLogin
+  @Log(title = "字典类型", businessType = BusinessType.UPDATE)
+  @SaCheckPermission(value = "system:dict:edit")
+  @PutMapping
+  public AjaxResult edit(@Validated @RequestBody SysDictType dict) {
+    if (UserConstants.NOT_UNIQUE.equals(dictTypeService.checkDictTypeUnique(dict))) {
+      return AjaxResult.error("修改字典'" + dict.getDictName() + "'失败，字典类型已存在");
     }
+    BaseEntityUtils.preUpdate(dict);
+    return toAjax(dictTypeService.updateById(dict));
+  }
 
-    /**
-     * 删除字典类型
-     */
-    @SaCheckLogin
-    @Log(title = "字典类型", businessType = BusinessType.DELETE)
-    @SaCheckPermission(value = "system:dict:remove")
-    @DeleteMapping("/{dictIds}")
-    public AjaxResult remove(@PathVariable String[] dictIds)
-    {
-        return toAjax(dictTypeService.removeByIds(Arrays.asList(dictIds)));
-    }
+  /**
+   * 删除字典类型
+   */
+  @SaCheckLogin
+  @Log(title = "字典类型", businessType = BusinessType.DELETE)
+  @SaCheckPermission(value = "system:dict:remove")
+  @DeleteMapping("/{dictIds}")
+  public AjaxResult remove(@PathVariable String[] dictIds) {
+    return toAjax(dictTypeService.removeByIds(Arrays.asList(dictIds)));
+  }
 
-    /**
-     * 清空缓存
-     */
-    @SaCheckLogin
-    @Log(title = "字典类型", businessType = BusinessType.CLEAN)
-    @SaCheckPermission(value = "system:dict:remove")
-    @DeleteMapping("/clearCache")
-    public AjaxResult clearCache()
-    {
-        dictTypeService.clearCache();
-        return AjaxResult.success();
-    }
+  /**
+   * 清空缓存
+   */
+  @SaCheckLogin
+  @Log(title = "字典类型", businessType = BusinessType.CLEAN)
+  @SaCheckPermission(value = "system:dict:remove")
+  @DeleteMapping("/clearCache")
+  public AjaxResult clearCache() {
+    dictTypeService.clearCache();
+    return AjaxResult.success();
+  }
 
-    /**
-     * 获取字典选择框列表
-     */
-    @GetMapping("/optionselect")
-    public AjaxResult optionselect()
-    {
-        List<SysDictType> dictTypes = dictTypeService.selectDictTypeAll();
-        return AjaxResult.success(dictTypes);
-    }
+  /**
+   * 获取字典选择框列表
+   */
+  @GetMapping("/optionselect")
+  public AjaxResult optionselect() {
+    List<SysDictType> dictTypes = dictTypeService.selectDictTypeAll();
+    return AjaxResult.success(dictTypes);
+  }
 }

shuili-common/target/classes/fdfs.yml

@@ -1,19 +0,0 @@
-fdfs:
-  so-timeout: 1500 # socket连接超时时间
-  connect-timeout: 6000 # 连接tracker超时时间
-  thumb-image:             #缩略图生成参数 ，可选
-    width: 150
-    height: 150
-  tracker-list:            #TrackerList参数,支持多个
-  - 192.168.1.20:22122
-  pool:
-    #从池中借出的对象的最大数目（配置为-1表示不限制）
-    max-total: -1
-    #获取连接时的最大等待毫秒数,默认值5000
-    max-wait-millis: 5000 #
-    #每个key最大连接数
-    max-total-per-key: 50
-    #每个key对应的连接池最大空闲连接数
-    max-idle-per-key: 10
-    #每个key对应的连接池最小空闲连接数
-    max_idle_per_key: 5