swagger文档

src/main/java/io/linfeng/common/utils/Constant.java

@@ -47,47 +47,6 @@ public class Constant {
     public static final Integer USER_NORMAL = 0;
     public static final Integer USER_BANNER = 1;
 
-    /**
-     * 圈子是否禁用
-     */
-    public static final Integer TOPIC_NORMAL = 0;
-    public static final Integer TOPIC_BANNER = 1;
-    /**
-     * 敏感词是否开启审核
-     */
-    public static final Integer SENSITIVE_CLOSE = 0;
-    public static final Integer SENSITIVE_OPEN = 1;
-    /**
-     * 敏感词处理措施 1-禁止发布 2-需审核
-     */
-    public static final Integer DEAL_BANNER = 1;
-    public static final Integer DEAL_EXAMINE = 2;
-
-    /**
-     * 1为点赞，2为评论  3为收藏 4为关注  5为推送通知 6私聊
-     */
-    public static final Integer STAR = 1;
-    public static final Integer COMMENT = 2;
-    public static final Integer COLLECT = 3;
-    public static final Integer WATCH = 4;
-    public static final Integer PUSHARTICLE = 5;
-    public static final Integer CHAT = 6;
-
-    public static final String TITLE_WATCH = "关注通知";
-    public static final String TITLE_COMMENT = "评论通知";
-    public static final String TITLE_STAR = "点赞通知";
-    public static final String TITLE_COLLECT = "点赞收藏通知";
-    public static final String TITLE_CHAT = "私聊通知";
-    public static final String TITLE_VIOLATION = "违规通知";
-
-
-    public static final String CONTENT_WATCH = "用户【{}】关注了你";
-    public static final String CONTENT_STAR = "用户【{}】点赞了你的评论:{}";
-    public static final String CONTENT_COMMENT = "用户【{}】评论了你的动态[{}]:{}";
-    public static final String CONTENT_COMMENT_REPLY = "用户【{}】回复了你在动态[{}]下的评论:{}";
-    public static final String CONTENT_POST_STAR = "用户【{}】点赞收藏了你的动态:{}";
-    public static final String ADMIN_POST_DOWN = "你的动态【{}】由于违反社区规定已被删除";
-
 
     /**
      * 手机验证码长度

src/main/java/io/linfeng/modules/admin/controller/AppUserController.java

@@ -13,13 +13,11 @@
 import java.util.Arrays;
 import java.util.Map;
 
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.apache.shiro.authz.annotation.RequiresPermissions;
 import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.*;
-import org.springframework.web.bind.annotation.RequestBody;
-import org.springframework.web.bind.annotation.RequestMapping;
-import org.springframework.web.bind.annotation.RequestParam;
-import org.springframework.web.bind.annotation.RestController;
 
 import io.linfeng.modules.admin.entity.AppUserEntity;
 import io.linfeng.modules.admin.service.AppUserService;
@@ -30,22 +28,22 @@ import io.linfeng.common.utils.R;
 
 /**
  * 
- *
+ * 管理端——会员管理
  * @author linfeng
  * @email 2445465217@qq.com
  * @date 2022-01-20 12:10:43
  */
+@Api(tags = "管理端——会员管理")
 @RestController
 @RequestMapping("admin/user")
 public class AppUserController {
     @Autowired
     private AppUserService appUserService;
 
-    /**
+
-     * 列表
+    @GetMapping("/list")
-     */
-    @RequestMapping("/list")
     @RequiresPermissions("admin:user:list")
+    @ApiOperation("用户列表")
     public R list(@RequestParam Map<String, Object> params){
         PageUtils page = appUserService.queryPage(params);
 
@@ -53,65 +51,60 @@ public class AppUserController {
     }
 
 
-    /**
+
-     * 信息
+    @GetMapping("/info/{uid}")
-     */
-    @RequestMapping("/info/{uid}")
     @RequiresPermissions("admin:user:info")
+    @ApiOperation("用户详情")
     public R info(@PathVariable("uid") Integer uid){
 		AppUserEntity user = appUserService.getById(uid);
 
         return R.ok().put("user", user);
     }
 
-    /**
+
-     * 保存
+    @PostMapping("/save")
-     */
-    @RequestMapping("/save")
     @RequiresPermissions("admin:user:save")
+    @ApiOperation("用户保存")
     public R save(@RequestBody AppUserEntity user){
 		appUserService.save(user);
 
         return R.ok();
     }
 
-    /**
+
-     * 修改
+    @PostMapping("/update")
-     */
-    @RequestMapping("/update")
     @RequiresPermissions("admin:user:update")
+    @ApiOperation("用户修改")
     public R update(@RequestBody AppUserEntity user){
 		appUserService.updateById(user);
 
         return R.ok();
     }
 
-    /**
+
-     * 删除
+    @PostMapping("/delete")
-     */
-    @RequestMapping("/delete")
     @RequiresPermissions("admin:user:delete")
+    @ApiOperation("用户修改")
     public R delete(@RequestBody Integer[] uids){
 		appUserService.removeByIds(Arrays.asList(uids));
 
         return R.ok();
     }
 
-    /**
+
-     * 用户禁用
+    @PostMapping("/ban/{id}")
-     */
+    @RequiresPermissions("admin:user:update")
-    @RequestMapping("/ban/{id}")
+    @ApiOperation("用户禁用")
-    @RequiresPermissions("admin:user:delete")
     public R ban(@PathVariable("id") Integer id){
 		appUserService.ban(id);
 
         return R.ok();
     }
-    /**
+
-     * 用户解除禁用
+
-     */
+    @PostMapping("/openBan/{id}")
-    @RequestMapping("/openBan/{id}")
+    @RequiresPermissions("admin:user:update")
-    @RequiresPermissions("admin:user:delete")
+    @ApiOperation("用户解除禁用")
     public R openBan(@PathVariable("id") Integer id){
 		appUserService.openBan(id);
 

src/main/java/io/linfeng/modules/admin/controller/CategoryController.java

@@ -14,6 +14,8 @@ package io.linfeng.modules.admin.controller;
 import java.util.Arrays;
 import java.util.Map;
 
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.apache.shiro.authz.annotation.RequiresPermissions;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.*;
@@ -31,6 +33,7 @@ import io.linfeng.common.utils.R;
  * @email 2445465217@qq.com
  * @date 2022-01-21 14:32:52
  */
+@Api(tags = "管理端——分类管理")
 @RestController
 @RequestMapping("admin/category")
 public class CategoryController {
@@ -39,11 +42,10 @@ public class CategoryController {
     @Autowired
     private CategoryService categoryService;
 
-    /**
+
-     * 列表
-     */
     @GetMapping("/list")
     @RequiresPermissions("admin:category:list")
+    @ApiOperation("分类列表")
     public R list(@RequestParam Map<String, Object> params){
         PageUtils page = categoryService.queryPage(params);
 
@@ -51,22 +53,20 @@ public class CategoryController {
     }
 
 
-    /**
+
-     * 信息
-     */
     @GetMapping("/info/{cateId}")
     @RequiresPermissions("admin:category:info")
+    @ApiOperation("分类详情")
     public R info(@PathVariable("cateId") Integer cateId){
 		CategoryEntity category = categoryService.getById(cateId);
 
         return R.ok().put("category", category);
     }
 
-    /**
+
-     * 保存
-     */
     @PostMapping("/save")
     @RequiresPermissions("admin:category:save")
+    @ApiOperation("分类保存")
     public R save(@RequestBody CategoryEntity category){
 
 		categoryService.saveCategory(category);
@@ -74,22 +74,20 @@ public class CategoryController {
         return R.ok();
     }
 
-    /**
+
-     * 修改
-     */
     @PostMapping("/update")
     @RequiresPermissions("admin:category:update")
+    @ApiOperation("分类修改")
     public R update(@RequestBody CategoryEntity category){
 		categoryService.updateById(category);
 
         return R.ok();
     }
 
-    /**
+
-     * 删除
-     */
     @PostMapping("/delete")
     @RequiresPermissions("admin:category:delete")
+    @ApiOperation("分类删除")
     public R delete(@RequestBody Integer[] cateIds){
 		categoryService.deleteByIdList(Arrays.asList(cateIds));