【添加】字典控制器添加swagger

jero-boot/jero-boot-module-system/src/main/java/com/jero/modules/system/controller/SysDictController.java

@@ -6,6 +6,8 @@ import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
 import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
 import com.baomidou.mybatisplus.core.metadata.IPage;
 import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import lombok.extern.slf4j.Slf4j;
 import org.apache.shiro.SecurityUtils;
 import org.apache.shiro.authz.annotation.RequiresRoles;
@@ -54,6 +56,7 @@ import java.util.*;
  * @since 2018-12-28
  */
 @RestController
+@Api(tags = "字典控制器")
 @RequestMapping("/sys/dict")
 @Slf4j
 public class SysDictController {
@@ -66,6 +69,7 @@ public class SysDictController {
 	public RedisTemplate<String, Object> redisTemplate;
 
 	@RequestMapping(value = "/list", method = RequestMethod.GET)
+	@ApiOperation(value = "字典控制器-分页列表查询", notes = "字典控制器-分页列表查询")
 	public Result<IPage<SysDict>> queryPageList(SysDict sysDict, @RequestParam(name="pageNo", defaultValue="1") Integer pageNo,
                                                 @RequestParam(name="pageSize", defaultValue="10") Integer pageSize, HttpServletRequest req) {
 		Result<IPage<SysDict>> result = new Result<IPage<SysDict>>();
@@ -90,6 +94,7 @@ public class SysDictController {
 	 * @return
 	 */
 	@SuppressWarnings("unchecked")
+	@ApiOperation(value = "字典控制器-树形字典数据", notes = "字典控制器-树形字典数据")
 	@RequestMapping(value = "/treeList", method = RequestMethod.GET)
 	public Result<List<SysDictTree>> treeList(SysDict sysDict, @RequestParam(name="pageNo", defaultValue="1") Integer pageNo,
                                               @RequestParam(name="pageSize", defaultValue="10") Integer pageSize, HttpServletRequest req) {
@@ -117,6 +122,7 @@ public class SysDictController {
 	 * @param dictCode 表名,文本字段,code字段  | 举例：sys_user,realname,id
 	 * @return
 	 */
+	@ApiOperation(value = "字典控制器-根据字典编码获取字典数据", notes = "字典控制器-根据字典编码获取字典数据")
 	@RequestMapping(value = "/getDictItems/{dictCode}", method = RequestMethod.GET)
 	public Result<List<DictModel>> getDictItems(@PathVariable String dictCode, @RequestParam(value = "sign",required = false) String sign, HttpServletRequest request) {
 		log.info(" dictCode : "+ dictCode);
@@ -167,6 +173,7 @@ public class SysDictController {
 	 *
 	 * @return
 	 */
+	@ApiOperation(value = "字典控制器-获取全部字典数据", notes = "字典控制器-获取全部字典数据")
 	@RequestMapping(value = "/queryAllDictItems", method = RequestMethod.GET)
 	public Result<?> queryAllDictItems(HttpServletRequest request) {
 		Map<String, List<DictModel>> res = new HashMap<String, List<DictModel>>();
@@ -179,6 +186,7 @@ public class SysDictController {
 	 * @param dictCode
 	 * @return
 	 */
+	@ApiOperation(value = "字典控制器-通过字典code和字典值key获取字典数据", notes = "字典控制器-通过字典code和字典值key获取字典数据")
 	@RequestMapping(value = "/getDictText/{dictCode}/{key}", method = RequestMethod.GET)
 	public Result<String> getDictText(@PathVariable("dictCode") String dictCode, @PathVariable("key") String key) {
 		log.info(" dictCode : "+ dictCode);
@@ -201,6 +209,7 @@ public class SysDictController {
 	 * @param dictCode
 	 * @return
 	 */
+	@ApiOperation(value = "字典控制器-通过字典code获取字典数据", notes = "字典控制器-通过字典code获取字典数据")
 	@RequestMapping(value = "/loadDict/{dictCode}", method = RequestMethod.GET)
 	public Result<List<DictModel>> loadDict(@PathVariable String dictCode,
                                             @RequestParam(name="keyword") String keyword,
@@ -239,6 +248,7 @@ public class SysDictController {
 	/**
 	 * 根据字典code加载字典text 返回
 	 */
+	@ApiOperation(value = "字典控制器-根据字典code加载字典text", notes = "字典控制器-根据字典code加载字典text")
 	@RequestMapping(value = "/loadDictItem/{dictCode}", method = RequestMethod.GET)
 	public Result<List<String>> loadDictItem(@PathVariable String dictCode, @RequestParam(name="key") String keys, @RequestParam(value = "sign",required = false) String sign, HttpServletRequest request) {
 		Result<List<String>> result = new Result<>();
@@ -270,6 +280,7 @@ public class SysDictController {
 	 * 根据表名——显示字段-存储字段 pid 加载树形数据
 	 */
 	@SuppressWarnings("unchecked")
+	@ApiOperation(value = "字典控制器-根据表名——显示字段-存储字段 pid 加载树形数据", notes = "字典控制器-根据表名——显示字段-存储字段 pid 加载树形数据")
 	@RequestMapping(value = "/loadTreeData", method = RequestMethod.GET)
 	public Result<List<TreeSelectModel>> loadTreeData(@RequestParam(name="pid") String pid, @RequestParam(name="pidField") String pidField,
                                                       @RequestParam(name="tableName") String tbname,
@@ -292,34 +303,12 @@ public class SysDictController {
 		return result;
 	}
 
-	/**
-	 * 【APP接口】根据字典配置查询表字典数据（目前暂未找到调用的地方）
-	 * @param query
-	 * @param pageNo
-	 * @param pageSize
-	 * @return
-	 */
-	@Deprecated
-	@GetMapping("/queryTableData")
-	public Result<List<DictModel>> queryTableData(DictQuery query,
-                                                  @RequestParam(name = "pageNo", defaultValue = "1") Integer pageNo,
-                                                  @RequestParam(name = "pageSize", defaultValue = "10") Integer pageSize,
-                                                  @RequestParam(value = "sign",required = false) String sign, HttpServletRequest request){
-		Result<List<DictModel>> res = new Result<List<DictModel>>();
-		// SQL注入漏洞 sign签名校验
-		String dictCode = query.getTable()+","+query.getText()+","+query.getCode();
-        SqlInjectionUtil.filterContent(dictCode);
-		List<DictModel> ls = this.sysDictService.queryDictTablePageList(query,pageSize,pageNo);
-		res.setResult(ls);
-		res.setSuccess(true);
-		return res;
-	}
-
 	/**
 	 * @功能：新增
 	 * @param sysDict
 	 * @return
 	 */
+	@ApiOperation(value = "字典控制器-新增字典", notes = "字典控制器-新增字典")
 	@RequiresRoles({"admin"})
 	@RequestMapping(value = "/add", method = RequestMethod.POST)
 	public Result<SysDict> add(@RequestBody SysDict sysDict) {
@@ -341,6 +330,7 @@ public class SysDictController {
 	 * @param sysDict
 	 * @return
 	 */
+	@ApiOperation(value = "字典控制器-编辑字典", notes = "字典控制器-编辑字典")
 	@RequiresRoles({"admin"})
 	@RequestMapping(value = "/edit", method = RequestMethod.PUT)
 	public Result<SysDict> edit(@RequestBody SysDict sysDict) {
@@ -363,8 +353,9 @@ public class SysDictController {
 	 * @param id
 	 * @return
 	 */
+	@ApiOperation(value = "字典控制器-删除字典", notes = "字典控制器-删除字典")
 	@RequiresRoles({"admin"})
-	@RequestMapping(value = "/delete", method = RequestMethod.DELETE)
+	@DeleteMapping(value = "/delete")
 	@CacheEvict(value=CacheConstant.SYS_DICT_CACHE, allEntries=true)
 	public Result<SysDict> delete(@RequestParam(name="id",required=true) String id) {
 		Result<SysDict> result = new Result<SysDict>();
@@ -382,8 +373,9 @@ public class SysDictController {
 	 * @param ids
 	 * @return
 	 */
+	@ApiOperation(value = "字典控制器-批量字典", notes = "字典控制器-批量字典")
 	@RequiresRoles({"admin"})
-	@RequestMapping(value = "/deleteBatch", method = RequestMethod.DELETE)
+	@DeleteMapping(value = "/deleteBatch")
 	@CacheEvict(value= CacheConstant.SYS_DICT_CACHE, allEntries=true)
 	public Result<SysDict> deleteBatch(@RequestParam(name="ids",required=true) String ids) {
 		Result<SysDict> result = new Result<SysDict>();
@@ -462,7 +454,7 @@ public class SysDictController {
 	 * @return
 	 */
 	@RequiresRoles({"admin"})
-	@RequestMapping(value = "/importExcel", method = RequestMethod.POST)
+	@PostMapping(value = "/importExcel")
 	public Result<?> importExcel(HttpServletRequest request, HttpServletResponse response) {
  		MultipartHttpServletRequest multipartRequest = (MultipartHttpServletRequest) request;
 		Map<String, MultipartFile> fileMap = multipartRequest.getFileMap();
@@ -521,7 +513,7 @@ public class SysDictController {
 	 * 查询被删除的列表
 	 * @return
 	 */
-	@RequestMapping(value = "/deleteList", method = RequestMethod.GET)
+	@GetMapping(value = "/deleteList")
 	public Result<List<SysDict>> deleteList() {
 		Result<List<SysDict>> result = new Result<List<SysDict>>();
 		List<SysDict> list = this.sysDictService.queryDeleteList();
@@ -535,7 +527,7 @@ public class SysDictController {
 	 * @param id
 	 * @return
 	 */
-	@RequestMapping(value = "/deletePhysic/{id}", method = RequestMethod.DELETE)
+	@DeleteMapping(value = "/deletePhysic/{id}")
 	public Result<?> deletePhysic(@PathVariable String id) {
 		try {
 			sysDictService.deleteOneDictPhysically(id);
@@ -551,7 +543,7 @@ public class SysDictController {
 	 * @param id
 	 * @return
 	 */
-	@RequestMapping(value = "/back/{id}", method = RequestMethod.PUT)
+	@PutMapping(value = "/back/{id}")
 	public Result<?> back(@PathVariable String id) {
 		try {
 			sysDictService.updateDictDelFlag(0,id);