From 97bbd04a461ae25aefb384fd0da92e54315391e7 Mon Sep 17 00:00:00 2001 From: jingkang <1248303996@qq.com> Date: Fri, 10 Apr 2020 14:54:56 +0800 Subject: [PATCH] =?UTF-8?q?pc=E5=90=8E=E5=8F=B0=E7=AE=A1=E7=90=86?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- pccenter/pom.xml | 40 ++++++++--- .../java/com/woniu/PccenterApplication.java | 2 + .../java/com/woniu/config/ShiroConfig.java | 6 +- .../java/com/woniu/config/Swagger2Config.java | 67 +++++++++++++++++++ .../ActivityComplainController.java | 19 ++++++ .../woniu/controller/ActivityController.java | 19 ++++++ .../com/woniu/controller/AdminController.java | 22 ++++++ .../woniu/controller/ComplainController.java | 26 +++++-- .../controller/DynamicCommentController.java | 28 +++++++- .../com/woniu/controller/MenusController.java | 23 +++++++ .../woniu/controller/MerchantController.java | 19 ++++++ .../controller/PropertyManageController.java | 20 +++++- .../com/woniu/controller/RolesController.java | 26 +++++++ .../controller/ServiceCommentController.java | 22 +++++- .../src/main/java/com/woniu/pojo/Admin.java | 2 + 15 files changed, 318 insertions(+), 23 deletions(-) create mode 100644 pccenter/src/main/java/com/woniu/config/Swagger2Config.java diff --git a/pccenter/pom.xml b/pccenter/pom.xml index c0d7080..7b74e38 100644 --- a/pccenter/pom.xml +++ b/pccenter/pom.xml @@ -105,12 +105,40 @@ + + + + org.springframework.cloud + spring-cloud-starter-netflix-eureka-client + 2.2.2.RELEASE + + + + org.springframework.cloud + spring-cloud-starter-netflix-zuul + 2.2.2.RELEASE + + + + io.springfox + springfox-swagger2 + 2.9.2 + + + io.swagger + swagger-annotations + + + io.swagger + swagger-models + + + io.springfox springfox-swagger-ui 2.9.2 - io.swagger swagger-annotations @@ -121,16 +149,6 @@ swagger-models 1.5.21 - - - org.springframework.cloud - spring-cloud-starter-netflix-eureka-client - - - - org.springframework.cloud - spring-cloud-starter-netflix-zuul - diff --git a/pccenter/src/main/java/com/woniu/PccenterApplication.java b/pccenter/src/main/java/com/woniu/PccenterApplication.java index 56afdaf..7c961e4 100644 --- a/pccenter/src/main/java/com/woniu/PccenterApplication.java +++ b/pccenter/src/main/java/com/woniu/PccenterApplication.java @@ -4,9 +4,11 @@ import org.mybatis.spring.annotation.MapperScan; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.cache.annotation.EnableCaching; +import org.springframework.cloud.netflix.eureka.EnableEurekaClient; @SpringBootApplication @MapperScan(value = "com.woniu.dao") +@EnableEurekaClient public class PccenterApplication { public static void main(String[] args) { diff --git a/pccenter/src/main/java/com/woniu/config/ShiroConfig.java b/pccenter/src/main/java/com/woniu/config/ShiroConfig.java index e40264f..0fa4e6d 100644 --- a/pccenter/src/main/java/com/woniu/config/ShiroConfig.java +++ b/pccenter/src/main/java/com/woniu/config/ShiroConfig.java @@ -47,7 +47,11 @@ public class ShiroConfig { map.put("/admin/subLogin","anon"); map.put("/src/**","anon"); map.put("/logout","logout"); - map.put("/**","authc"); + map.put("/swagger-ui.html**", "anon"); + map.put("/v2/api-docs", "anon"); + map.put("/swagger-resources/**", "anon"); + map.put("/webjars/**", "anon"); + //map.put("/**","authc"); filterFactoryBean.setFilterChainDefinitionMap(map); return filterFactoryBean; } diff --git a/pccenter/src/main/java/com/woniu/config/Swagger2Config.java b/pccenter/src/main/java/com/woniu/config/Swagger2Config.java new file mode 100644 index 0000000..66a5943 --- /dev/null +++ b/pccenter/src/main/java/com/woniu/config/Swagger2Config.java @@ -0,0 +1,67 @@ +package com.woniu.config; + +import io.swagger.annotations.Api; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry; +import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport; +import springfox.documentation.builders.ApiInfoBuilder; +import springfox.documentation.builders.PathSelectors; +import springfox.documentation.builders.RequestHandlerSelectors; +import springfox.documentation.service.ApiInfo; +import springfox.documentation.service.Contact; +import springfox.documentation.spi.DocumentationType; +import springfox.documentation.spring.web.plugins.Docket; +import springfox.documentation.swagger2.annotations.EnableSwagger2; + +@Configuration +@EnableSwagger2 +public class Swagger2Config extends WebMvcConfigurationSupport { + + @Bean + public Docket createRestApi(){ + return new Docket(DocumentationType.SWAGGER_2) + .apiInfo(apiInfo()) + .select() + //为当前包下controller生成API文档 +// .apis(RequestHandlerSelectors.basePackage("com.troila")) + //为有@Api注解的Controller生成API文档 +// .apis(RequestHandlerSelectors.withClassAnnotation(Api.class)) + //为有@ApiOperation注解的方法生成API文档 +// .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)) + //为任何接口生成API文档 + .apis(RequestHandlerSelectors.any()) + .paths(PathSelectors.any()) + .build(); + //添加登录认证 + /*.securitySchemes(securitySchemes()) + .securityContexts(securityContexts());*/ + } + + private ApiInfo apiInfo() { + Contact contact = new Contact("yunqing", "", "yunqing****@gmail.com"); + return new ApiInfoBuilder() + .title("SwaggerUI演示") + .description("接口文档，描述词省略200字") + .contact(contact) + .version("1.0") + .build(); + } + + /** + * 配置swagger2的静态资源路径 + * @param registry + */ + @Override + protected void addResourceHandlers(ResourceHandlerRegistry registry) { + // 解决静态资源无法访问 + registry.addResourceHandler("/**") + .addResourceLocations("classpath:/static/"); + // 解决swagger无法访问 + registry.addResourceHandler("/swagger-ui.html") + .addResourceLocations("classpath:/META-INF/resources/"); + // 解决swagger的js文件无法访问 + registry.addResourceHandler("/webjars/**") + .addResourceLocations("classpath:/META-INF/resources/webjars/"); + } +} diff --git a/pccenter/src/main/java/com/woniu/controller/ActivityComplainController.java b/pccenter/src/main/java/com/woniu/controller/ActivityComplainController.java index f0a5a5f..261607e 100644 --- a/pccenter/src/main/java/com/woniu/controller/ActivityComplainController.java +++ b/pccenter/src/main/java/com/woniu/controller/ActivityComplainController.java @@ -4,6 +4,10 @@ import com.github.pagehelper.PageInfo; import com.woniu.common.CommonResult; import com.woniu.dto.ActivityComplainDTO; import com.woniu.service.ActivityComplainService; +import io.swagger.annotations.Api; +import io.swagger.annotations.ApiImplicitParam; +import io.swagger.annotations.ApiImplicitParams; +import io.swagger.annotations.ApiOperation; import org.apache.shiro.authz.annotation.RequiresPermissions; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Controller; @@ -14,6 +18,7 @@ import java.util.List; @Controller @RequestMapping("/ac_complain") +@Api(tags ="活动投诉") public class ActivityComplainController { @Autowired @@ -28,6 +33,11 @@ public class ActivityComplainController { @RequestMapping("list") @ResponseBody @RequiresPermissions("sys:acc:list") + @ApiOperation(value = "活动投诉列表分页查询") + @ApiImplicitParams({ + @ApiImplicitParam(name = "currentPage",value = "当前页数",defaultValue = "1"), + @ApiImplicitParam(name = "pageSize",value = "每页数据条数",defaultValue = "5") + }) public CommonResult list(@RequestParam(value = "page",defaultValue = "1",required = false)Integer currentPage, @RequestParam(value = "limit",defaultValue = "5",required = false)Integer pageSize){ PageInfo info=null; @@ -48,6 +58,8 @@ public class ActivityComplainController { @RequestMapping("/reply/{id}") @ResponseBody @RequiresPermissions("sys:acc:reply") + @ApiOperation(value = "导航到回复投诉的页面") + @ApiImplicitParam(name = "id",value = "投诉列表ID",dataType = "Integer") public ModelAndView reply(@PathVariable("id")Integer id){ ActivityComplainDTO activityComplainDTO=acComplainService.findById(id); ModelAndView model=new ModelAndView("sys/ac_reply"); @@ -62,6 +74,8 @@ public class ActivityComplainController { */ @PutMapping("/editComplain") @ResponseBody + @ApiOperation(value = "投诉回复内容的添加") + @ApiImplicitParam(name = "activityComplainDTO",value = "回复内容") public CommonResult addReply(ActivityComplainDTO activityComplainDTO){ try { acComplainService.addReply(activityComplainDTO); @@ -81,6 +95,11 @@ public class ActivityComplainController { */ @RequestMapping("/select") @ResponseBody + @ApiOperation(value = "活动投诉页面搜索") + @ApiImplicitParams({ + @ApiImplicitParam(name = "nickName",value = "用户姓名"), + @ApiImplicitParam(name = "title",value = "活动标题") + }) public CommonResult select(String nickName,String title){ PageInfo info=null; try { diff --git a/pccenter/src/main/java/com/woniu/controller/ActivityController.java b/pccenter/src/main/java/com/woniu/controller/ActivityController.java index fc5f701..011de0a 100644 --- a/pccenter/src/main/java/com/woniu/controller/ActivityController.java +++ b/pccenter/src/main/java/com/woniu/controller/ActivityController.java @@ -4,6 +4,10 @@ import com.github.pagehelper.PageInfo; import com.woniu.common.CommonResult; import com.woniu.dto.ActivityDTO; import com.woniu.service.ActivityService; +import io.swagger.annotations.Api; +import io.swagger.annotations.ApiImplicitParam; +import io.swagger.annotations.ApiImplicitParams; +import io.swagger.annotations.ApiOperation; import org.apache.shiro.authz.annotation.RequiresPermissions; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Controller; @@ -13,6 +17,7 @@ import java.util.Date; import java.util.List; @Controller @RequestMapping("/activity") +@Api(tags = "活动审批模块") public class ActivityController { @Autowired @@ -27,6 +32,11 @@ public class ActivityController { @RequestMapping("/list") @ResponseBody @RequiresPermissions("sys:al:list") + @ApiOperation(value = "活动审批分页查询") + @ApiImplicitParams({ + @ApiImplicitParam(name = "currentPage",value = "当前页数",defaultValue = "1"), + @ApiImplicitParam(name = "pageSize",value = "每页数据条数",defaultValue = "5") + }) public CommonResult pmList(@RequestParam(value = "page",defaultValue = "1",required = false)Integer currentPage, @RequestParam(value = "limit",defaultValue = "5",required = false)Integer pageSize){ PageInfo info = null; @@ -49,6 +59,8 @@ public class ActivityController { @PutMapping("/confirm/{id}") @ResponseBody @RequiresPermissions("sys:al:examine") + @ApiOperation(value = "活动审批") + @ApiImplicitParam(name = "id",value = "活动编号id值",dataType = "Integer") public CommonResult confirmPM(@PathVariable("id") Integer id){ System.out.println("活动确认审核"+id); Date examineTime=new Date(); @@ -69,6 +81,11 @@ public class ActivityController { */ @RequestMapping("/select") @ResponseBody + @ApiOperation(value = "活动审批页面搜索") + @ApiImplicitParams({ + @ApiImplicitParam(name = "name",value = "用户名称"), + @ApiImplicitParam(name = "status",value = "审批状态",dataType = "Integer") + }) public CommonResult select(String name,Integer status){ PageInfo info=null; try { @@ -88,6 +105,8 @@ public class ActivityController { */ @RequestMapping("/refuse/{id}") @ResponseBody + @ApiOperation(value = "拒绝审批") + @ApiImplicitParam(name = "id",value = "活动编号id值",dataType = "Integer") public CommonResult refuse(@PathVariable("id")Integer id){ //获取当前时间 Date examineTime=new Date(); diff --git a/pccenter/src/main/java/com/woniu/controller/AdminController.java b/pccenter/src/main/java/com/woniu/controller/AdminController.java index e1c98c4..f41970e 100644 --- a/pccenter/src/main/java/com/woniu/controller/AdminController.java +++ b/pccenter/src/main/java/com/woniu/controller/AdminController.java @@ -7,6 +7,10 @@ import com.woniu.pojo.Admin; import com.woniu.pojo.Roles; import com.woniu.service.AdminService; import com.woniu.service.RolesService; +import io.swagger.annotations.Api; +import io.swagger.annotations.ApiImplicitParam; +import io.swagger.annotations.ApiImplicitParams; +import io.swagger.annotations.ApiOperation; import org.apache.commons.collections.CollectionUtils; import org.apache.commons.collections.Transformer; import org.apache.shiro.SecurityUtils; @@ -29,6 +33,7 @@ import java.util.List; @Controller @RequestMapping("/admin") +@Api(tags = "管理员列表") public class AdminController { @Autowired @@ -47,6 +52,11 @@ public class AdminController { @RequestMapping("/list") @ResponseBody @RequiresPermissions("sys:admin:list") + @ApiOperation(value = "管理员列表分页展示数据") + @ApiImplicitParams({ + @ApiImplicitParam(name = "currentPage",value = "当前页数",defaultValue = "1"), + @ApiImplicitParam(name = "pageSize",value = "页面数据条数",defaultValue = "5") + }) public CommonResult list(@RequestParam(value = "page", defaultValue = "1", required = false) Integer currentPage, @RequestParam(value = "limit", defaultValue = "10", required = false) Integer pageSize) { PageInfo info = null; @@ -69,6 +79,7 @@ public class AdminController { * @param modelAndView * @return */ + @ApiOperation(value = "导航到添加管理员页面") @RequestMapping("/addAdmin") public ModelAndView addAdmin(ModelAndView modelAndView) { List roles = rolesService.findAll(); @@ -86,6 +97,8 @@ public class AdminController { @PostMapping("/saveAdmin") @ResponseBody @RequiresPermissions("sys:admin:save") + @ApiOperation(value = "添加管理员") + @ApiImplicitParam(name = "admin",value = "前端获取添加管理员的信息",paramType = "form") public CommonResult saveAdmin(Admin admin) { //验证用户名是否重复 @@ -111,6 +124,8 @@ public class AdminController { @DeleteMapping("/delAdmin/{keys}") @ResponseBody @RequiresPermissions("sys:admin:delete") + @ApiOperation(value = "批量删除管理员") + @ApiImplicitParam(name = "keys",value = "管理员id值的字符串",required = true) public CommonResult delAdmin(@PathVariable("keys") String keys) { List keysStringList = Arrays.asList(keys.split(",")); List list = new ArrayList<>(); @@ -135,6 +150,7 @@ public class AdminController { * @return */ @RequestMapping("/editAdmin/{id}") + @ApiOperation(value = "导航到编辑页面") public ModelAndView editAdmin(@PathVariable("id") Integer id) { Admin admin = adminService.findById(id); ModelAndView modelAndView = new ModelAndView("/sys/editAdmin"); @@ -153,6 +169,8 @@ public class AdminController { @PutMapping("/updateAdmin") @ResponseBody @RequiresPermissions("sys:admin:update") + @ApiOperation(value ="更新管理员" ) + @ApiImplicitParam(name = "admin",value = "传入修改管理员信息的值",paramType = "form") public CommonResult updateAdmin(Admin admin) { Admin dbAdmin = adminService.checkName(admin); if (dbAdmin != null) { @@ -177,6 +195,8 @@ public class AdminController { @DeleteMapping("/deleteAdmin/{id}") @ResponseBody @RequiresPermissions("sys:admin:delete") + @ApiOperation(value = "删除管理员") + @ApiImplicitParam(name = "id",value = "管理员ID值",dataType = "Integer") public CommonResult deleteAdmin(@PathVariable("id") Integer id) { try { adminService.deleteById(id); @@ -196,6 +216,8 @@ public class AdminController { @PostMapping("/subLogin") @ResponseBody + @ApiOperation(value = "后台管理员的登录验证") + @ApiImplicitParam(name = "admin",value = "账号与密码",required = true) public CommonResult subLogin(Admin admin) { System.out.println("传入的账号："+admin.getUsername()); System.out.println("传入的密码："+admin.getPassword()); diff --git a/pccenter/src/main/java/com/woniu/controller/ComplainController.java b/pccenter/src/main/java/com/woniu/controller/ComplainController.java index 78d932a..e729946 100644 --- a/pccenter/src/main/java/com/woniu/controller/ComplainController.java +++ b/pccenter/src/main/java/com/woniu/controller/ComplainController.java @@ -4,16 +4,22 @@ import com.github.pagehelper.PageInfo; import com.woniu.common.CommonResult; import com.woniu.dto.ComplainDTO; import com.woniu.service.ComplainService; +import io.swagger.annotations.Api; +import io.swagger.annotations.ApiImplicitParam; +import io.swagger.annotations.ApiImplicitParams; +import io.swagger.annotations.ApiOperation; import org.apache.shiro.authz.annotation.RequiresPermissions; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.*; import org.springframework.web.servlet.ModelAndView; +import javax.naming.Name; import java.util.List; @Controller @RequestMapping("/complain") +@Api(tags = "物业投诉模块") public class ComplainController { @Autowired @@ -28,6 +34,11 @@ public class ComplainController { @RequestMapping("/list") @ResponseBody @RequiresPermissions("sys:pmc:list") + @ApiOperation(value = "分页查询") + @ApiImplicitParams({ + @ApiImplicitParam(name = "currentPage",value = "当前页数",defaultValue = "1"), + @ApiImplicitParam(name = "pageSize",value = "页面数据条数",defaultValue = "5") + }) public CommonResult list(@RequestParam(value = "page",defaultValue = "1",required = false)Integer currentPage, @RequestParam(value = "limit",defaultValue = "5",required = false)Integer pageSize){ PageInfo info=null; @@ -48,6 +59,8 @@ public class ComplainController { */ @RequestMapping("/reply/{id}") @ResponseBody + @ApiOperation(value = "导航到回复投诉的页面") + @ApiImplicitParam(name = "id",value = "列表id",dataType = "Integer") public ModelAndView reply(@PathVariable("id")Integer id){ System.out.println("传入的id值为："+id); ComplainDTO complainDTO=complainService.findById(id); @@ -64,9 +77,10 @@ public class ComplainController { @PutMapping("/editComplain") @ResponseBody @RequiresPermissions("sys:pmc:reply") + @ApiOperation("投诉回复") + @ApiImplicitParam(name = "complainDTO",value = "回复内容",required = true) public CommonResult addReply(ComplainDTO complainDTO){ - System.out.println("回复投诉传入的id值："+complainDTO.getId()); - System.out.println("回复的内容："+complainDTO.getContext()); + try{ complainService.addReply(complainDTO); return CommonResult.success("回复上传成功"); @@ -85,9 +99,13 @@ public class ComplainController { */ @RequestMapping("/select") @ResponseBody + @ApiOperation("页面查询") + @ApiImplicitParams({ + @ApiImplicitParam(name = "userName",value = "用户名称"), + @ApiImplicitParam(name = "status",value = "审批状态") + }) public CommonResult select(String userName,Integer status){ - System.out.println("传入的userName："+userName); - System.out.println("传入的Status："+status); + PageInfo info=null; try { List list=complainService.select(userName,status); diff --git a/pccenter/src/main/java/com/woniu/controller/DynamicCommentController.java b/pccenter/src/main/java/com/woniu/controller/DynamicCommentController.java index 10dda96..cd2d978 100644 --- a/pccenter/src/main/java/com/woniu/controller/DynamicCommentController.java +++ b/pccenter/src/main/java/com/woniu/controller/DynamicCommentController.java @@ -4,6 +4,10 @@ import com.github.pagehelper.PageInfo; import com.woniu.common.CommonResult; import com.woniu.dto.DynamicCommentDTO; import com.woniu.service.DynamicCommentService; +import io.swagger.annotations.Api; +import io.swagger.annotations.ApiImplicitParam; +import io.swagger.annotations.ApiImplicitParams; +import io.swagger.annotations.ApiOperation; import org.apache.shiro.authz.annotation.RequiresPermissions; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Controller; @@ -13,6 +17,7 @@ import java.util.List; @Controller @RequestMapping("/dynamic_comment") +@Api(tags ="活动评论") public class DynamicCommentController { @Autowired private DynamicCommentService dc_Service; @@ -20,6 +25,11 @@ public class DynamicCommentController { @RequestMapping("/list") @ResponseBody @RequiresPermissions("sys:dc:list") + @ApiOperation(value = "分页查询") + @ApiImplicitParams({ + @ApiImplicitParam(name = "currentPage",value = "当前页数",defaultValue = "1"), + @ApiImplicitParam(name = "pageSize",value = "页面数据条数",defaultValue = "5") + }) public CommonResult list(@RequestParam(value = "page",defaultValue = "1",required = false)Integer currentPage, @RequestParam(value = "limit",defaultValue = "5",required = false)Integer pageSize){ PageInfo info=null; @@ -40,7 +50,9 @@ public class DynamicCommentController { */ @DeleteMapping("/delComment/{id}") @ResponseBody - @RequiresPermissions("sys:dc:update") + @RequiresPermissions("sys:dc:delete") + @ApiOperation(value = "删除评论") + @ApiImplicitParam(name = "id",value = "活动评论列表id",dataType = "Integer") public CommonResult delComment(@PathVariable("id")Integer id){ try { dc_Service.delComment(id); @@ -51,11 +63,21 @@ public class DynamicCommentController { return CommonResult.success("删除成功!"); } + /** + * 页面搜索 + * @param nickName + * @param dynamicType + * @return + */ @RequestMapping("/select") @ResponseBody + @ApiOperation("页面查询") + @ApiImplicitParams({ + @ApiImplicitParam(name = "nickName",value = "用户名称"), + @ApiImplicitParam(name = "dynamicType",value = "活动类型") + }) public CommonResult select(String nickName,Integer dynamicType){ - System.out.println("nickName:"+nickName); - System.out.println("dynamicType:"+dynamicType); + PageInfo info=null; try { List list=dc_Service.select(nickName,dynamicType); diff --git a/pccenter/src/main/java/com/woniu/controller/MenusController.java b/pccenter/src/main/java/com/woniu/controller/MenusController.java index 26a38be..6e5c485 100644 --- a/pccenter/src/main/java/com/woniu/controller/MenusController.java +++ b/pccenter/src/main/java/com/woniu/controller/MenusController.java @@ -8,6 +8,10 @@ import com.woniu.exception.MenuServiceException; import com.woniu.pojo.Admin; import com.woniu.pojo.Menus; import com.woniu.service.MenusService; +import io.swagger.annotations.Api; +import io.swagger.annotations.ApiImplicitParam; +import io.swagger.annotations.ApiImplicitParams; +import io.swagger.annotations.ApiOperation; import org.apache.shiro.SecurityUtils; import org.apache.shiro.authz.annotation.RequiresPermissions; import org.springframework.beans.factory.annotation.Autowired; @@ -21,6 +25,7 @@ import java.util.Map; @Controller @RequestMapping("/menus") +@Api(tags ="菜单管理") public class MenusController { @Autowired @@ -32,6 +37,7 @@ public class MenusController { */ @RequestMapping("/getMenus") @ResponseBody + @ApiOperation(value = "加载主页菜单数据") public List getMenus(){ //根据当前登录用户的角色来获取该用户能够访问哪些资源 Admin admin = (Admin) SecurityUtils.getSubject().getPrincipal(); @@ -45,6 +51,7 @@ public class MenusController { */ @RequestMapping("/loadTree") @ResponseBody + @ApiOperation(value = "加载树形菜单的数据") public String loadTree(){ List menus = menusService.findAll(); ObjectMapper mapper = new ObjectMapper(); @@ -65,6 +72,8 @@ public class MenusController { */ @RequestMapping("/loadCheckTree/{roleId}") @ResponseBody + @ApiOperation(value = "根据角色id查询菜单数据") + @ApiImplicitParam(name = "id",value = "角色ID值",dataType = "Integer") public String loadCheckTree(@PathVariable("roleId")Integer id){ List list = menusService.findCheckMenusByRoleId(id); ObjectMapper mapper = new ObjectMapper(); @@ -83,6 +92,7 @@ public class MenusController { @GetMapping("/loadMenus") @ResponseBody @RequiresPermissions("sys:menu:list") + @ApiOperation(value = "查询菜单列表的数据") public Map loadMenus(){ List menus = menusService.findAll(); Map result = new HashMap(); @@ -99,6 +109,7 @@ public class MenusController { * @return */ @RequestMapping("/addMenu/{parentId}") + @ApiOperation(value = "导航到添加菜单的页面") public String addMenu(Model model,@PathVariable("parentId") Long parentId){ model.addAttribute("parentId",parentId);//添加菜单节点的父Id return "/sys/addMenu"; @@ -112,6 +123,8 @@ public class MenusController { @PostMapping("/saveMenu") @ResponseBody @RequiresPermissions("sys:menu:save") + @ApiOperation(value = "添加菜单") + @ApiImplicitParam(name = "menus",value = "添加菜单信息") public CommonResult saveMenu(Menus menus){ //验证同级目录下的菜单节点名称不能重复 if(menusService.checkMenuName(menus)){ @@ -134,6 +147,8 @@ public class MenusController { @DeleteMapping("/del/{id}") @ResponseBody @RequiresPermissions("sys:menu:delete") + @ApiOperation(value = "删除菜单") + @ApiImplicitParam(name = "id",value = "菜单列表id",dataType = "Integer") public CommonResult del(@PathVariable("id") Integer mid){ try { menusService.delMenus(mid); @@ -154,6 +169,7 @@ public class MenusController { * @return */ @RequestMapping("/editMenu/{menuId}") + @ApiOperation(value = "导航到编辑菜单页面") public String updateMenu(Model model,@PathVariable("menuId") Integer menuId){ //查询该menuId下的数据 Menus menus=menusService.findByMenuId(menuId); @@ -168,6 +184,8 @@ public class MenusController { @PutMapping("/editMenu") @ResponseBody @RequiresPermissions("sys:menu:update") + @ApiOperation(value = "菜单编辑") + @ApiImplicitParam(name = "menus",value = "修改菜单信息") public CommonResult updateMenus(Menus menus){ try { menusService.updateMenus(menus); @@ -187,6 +205,11 @@ public class MenusController { */ @PutMapping("/updateMenusSorting") @ResponseBody + @ApiOperation(value = "菜单排序") + @ApiImplicitParams({ + @ApiImplicitParam(name = "menuId",value = "菜单ID",dataType = "Integer"), + @ApiImplicitParam(name = "sorting",value = "排序数值") + }) public CommonResult updateMenusSorting(Integer menuId, String sorting){ try { Integer.parseInt(sorting); diff --git a/pccenter/src/main/java/com/woniu/controller/MerchantController.java b/pccenter/src/main/java/com/woniu/controller/MerchantController.java index f591193..83562b5 100644 --- a/pccenter/src/main/java/com/woniu/controller/MerchantController.java +++ b/pccenter/src/main/java/com/woniu/controller/MerchantController.java @@ -4,6 +4,10 @@ import com.github.pagehelper.PageInfo; import com.woniu.common.CommonResult; import com.woniu.dto.MerchantDTO; import com.woniu.service.MerchantService; +import io.swagger.annotations.Api; +import io.swagger.annotations.ApiImplicitParam; +import io.swagger.annotations.ApiImplicitParams; +import io.swagger.annotations.ApiOperation; import org.apache.shiro.authz.annotation.RequiresPermissions; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Controller; @@ -15,6 +19,7 @@ import java.util.List; @Controller @RequestMapping("/merchant") +@Api(tags ="商家管理") public class MerchantController { @Autowired @@ -29,6 +34,11 @@ public class MerchantController { @RequestMapping("/list") @ResponseBody @RequiresPermissions("sys:ml:list") + @ApiOperation(value = "分页查询") + @ApiImplicitParams({ + @ApiImplicitParam(name = "currentPage",value = "当前页数",defaultValue = "1"), + @ApiImplicitParam(name = "pageSize",value = "页面数据条数",defaultValue = "5") + }) public CommonResult list(@RequestParam(value = "page",defaultValue = "1",required = false)Integer currentPage, @RequestParam(value = "limit",defaultValue = "5",required = false)Integer pageSize){ PageInfo info=null; @@ -51,6 +61,8 @@ public class MerchantController { @PutMapping("/confirm/{id}") @ResponseBody @RequiresPermissions("sys:ml:examine") + @ApiOperation(value = "商家审批") + @ApiImplicitParam(name = "id",value = "商家id值",dataType = "Integer") private CommonResult confirmPM(@PathVariable("id") Integer id){ //获取当前操作的时间 Date examineTime=new Date(); @@ -71,6 +83,11 @@ public class MerchantController { */ @RequestMapping("/select") @ResponseBody + @ApiOperation("页面查询") + @ApiImplicitParams({ + @ApiImplicitParam(name = "nickName",value = "用户名称"), + @ApiImplicitParam(name = "status",value = "审批状态") + }) public CommonResult select(String nickName,Integer status){ PageInfo info=null; try { @@ -90,6 +107,8 @@ public class MerchantController { */ @RequestMapping("/refuse/{id}") @ResponseBody + @ApiOperation(value = "拒绝审批") + @ApiImplicitParam(name = "id",value = "商家id值",dataType = "Integer") public CommonResult refuse(@PathVariable("id")Integer id){ Date refuseTime=new Date(); try { diff --git a/pccenter/src/main/java/com/woniu/controller/PropertyManageController.java b/pccenter/src/main/java/com/woniu/controller/PropertyManageController.java index 9ea489a..4719f5a 100644 --- a/pccenter/src/main/java/com/woniu/controller/PropertyManageController.java +++ b/pccenter/src/main/java/com/woniu/controller/PropertyManageController.java @@ -5,6 +5,10 @@ import com.woniu.common.CommonResult; import com.woniu.dto.MerchantDTO; import com.woniu.pojo.PropertyManage; import com.woniu.service.ProperManageService; +import io.swagger.annotations.Api; +import io.swagger.annotations.ApiImplicitParam; +import io.swagger.annotations.ApiImplicitParams; +import io.swagger.annotations.ApiOperation; import org.apache.shiro.authz.annotation.RequiresPermissions; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Controller; @@ -16,6 +20,7 @@ import java.util.List; @Controller @RequestMapping("/pm") +@Api(tags = "物业审核") public class PropertyManageController { @Autowired @@ -30,6 +35,11 @@ public class PropertyManageController { @RequestMapping("/list") @ResponseBody @RequiresPermissions("sys:pm:list") + @ApiOperation(value = "分页查询") + @ApiImplicitParams({ + @ApiImplicitParam(name = "currentPage",value = "当前页数",defaultValue = "1"), + @ApiImplicitParam(name = "pageSize",value = "页面数据条数",defaultValue = "5") + }) public CommonResult pmList(@RequestParam(value = "page",defaultValue = "1",required = false)Integer currentPage, @RequestParam(value = "limit",defaultValue = "5",required = false)Integer pageSize){ PageInfo info = null; @@ -53,6 +63,8 @@ public class PropertyManageController { @PutMapping("/confirm/{id}") @ResponseBody @RequiresPermissions("sys:pm:examine") + @ApiOperation(value = "物业审批") + @ApiImplicitParam(name = "id",value = "物业id值",dataType = "Integer") public CommonResult confirmPM(@PathVariable("id") Integer id){ //获取当前时间 Date passTime=new Date(); @@ -73,11 +85,15 @@ public class PropertyManageController { */ @RequestMapping("/select") @ResponseBody + @ApiOperation(value = "物业审批页面搜索") + @ApiImplicitParams({ + @ApiImplicitParam(name = "name",value = "用户名称"), + @ApiImplicitParam(name = "status",value = "审批状态",dataType = "Integer") + }) public CommonResult select(String userName,Integer status){ PageInfo info=null; try { List list=pmService.findList(userName,status); - System.out.println("查询到的列表数据条数："+list.size()); info=new PageInfo(list); return CommonResult.success(info); } catch (Exception e) { @@ -93,6 +109,8 @@ public class PropertyManageController { */ @PutMapping("/refuse/{id}") @ResponseBody + @ApiOperation(value = "拒绝审批") + @ApiImplicitParam(name = "id",value = "商家列表id值",dataType = "Integer") public CommonResult refuse(@PathVariable("id")Integer id){ //获取当前时间 Date refuseTime=new Date(); diff --git a/pccenter/src/main/java/com/woniu/controller/RolesController.java b/pccenter/src/main/java/com/woniu/controller/RolesController.java index b0089c7..6470434 100644 --- a/pccenter/src/main/java/com/woniu/controller/RolesController.java +++ b/pccenter/src/main/java/com/woniu/controller/RolesController.java @@ -5,6 +5,10 @@ import com.woniu.common.CommonResult; import com.woniu.exception.RoleServiceException; import com.woniu.pojo.Roles; import com.woniu.service.RolesService; +import io.swagger.annotations.Api; +import io.swagger.annotations.ApiImplicitParam; +import io.swagger.annotations.ApiImplicitParams; +import io.swagger.annotations.ApiOperation; import org.apache.commons.collections.CollectionUtils; import org.apache.commons.collections.Transformer; import org.apache.shiro.authz.annotation.RequiresPermissions; @@ -20,6 +24,7 @@ import java.util.stream.Collectors; @Controller @RequestMapping("/roles") +@Api(tags = "角色管理") public class RolesController { @Autowired @@ -28,6 +33,11 @@ public class RolesController { @RequestMapping("/list") @ResponseBody @RequiresPermissions("sys:role:list") + @ApiOperation(value = "分页查询") + @ApiImplicitParams({ + @ApiImplicitParam(name = "currentPage",value = "当前页数",defaultValue = "1"), + @ApiImplicitParam(name = "pageSize",value = "每页数据条数",defaultValue = "5") + }) public CommonResult list(@RequestParam(value="page",defaultValue = "1",required = false)Integer currentPage, @RequestParam(value = "limit",defaultValue = "5",required = false)Integer pageSize){ List roles = rolesService.findByPage(currentPage,pageSize); @@ -45,6 +55,11 @@ public class RolesController { @PostMapping("/saveRole") @ResponseBody @RequiresPermissions("sys:role:save") + @ApiOperation(value = "添加角色并授权") + @ApiImplicitParams({ + @ApiImplicitParam(name = "roles",value = "角色信息"), + @ApiImplicitParam(name = "menuId",value = "菜单ID",dataType = "Integer") + }) public CommonResult saveRole(Roles roles,String menuId){ //检查角色的名称不能重复 Roles result = rolesService.findByRoleName(roles.getRoleName()); @@ -77,6 +92,8 @@ public class RolesController { * @return */ @GetMapping("/editRole/{id}") + @ApiOperation(value = "导航到编辑页面") + @ApiImplicitParam(name = "id",value = "角色ID",dataType = "Integer") public ModelAndView editRole(@PathVariable("id")Integer id){ Roles roles = rolesService.findById(id); ModelAndView modelAndView = new ModelAndView("/sys/editRole"); @@ -91,6 +108,11 @@ public class RolesController { @PutMapping("/updateRole") @ResponseBody @RequiresPermissions("sys:role:update") + @ApiOperation(value = "编辑角色") + @ApiImplicitParams({ + @ApiImplicitParam(name = "roles",value = "编辑后的角色信息"), + @ApiImplicitParam(name = "menuId",value = "菜单ID",dataType = "Integer") + }) public CommonResult updateRole(Roles roles,String menuId){ //检查更新的角色名称是否已经存 @@ -124,6 +146,8 @@ public class RolesController { @DeleteMapping("/del/{id}") @ResponseBody @RequiresPermissions("sys:role:delete") + @ApiOperation(value = "删除角色") + @ApiImplicitParam(name = "id",value = "角色ID",dataType = "Integer") public CommonResult del(@PathVariable("id")Integer roleId){ try { rolesService.delRole(roleId); @@ -145,6 +169,8 @@ public class RolesController { @DeleteMapping("/batchDel/{keys}") @ResponseBody @RequiresPermissions("sys:role:delete") + @ApiOperation(value = "批量删除角色") + @ApiImplicitParam(name = "keys",value ="角色ID字符串" ) public CommonResult batchDel(@PathVariable("keys")String keys){ //List rolesId =Arrays.stream(keys.split(",")).map(s->Long.parseLong(s)).collect(Collectors.toList()); List keysStringList = Arrays.asList(keys.split(",")); diff --git a/pccenter/src/main/java/com/woniu/controller/ServiceCommentController.java b/pccenter/src/main/java/com/woniu/controller/ServiceCommentController.java index 241e081..299c340 100644 --- a/pccenter/src/main/java/com/woniu/controller/ServiceCommentController.java +++ b/pccenter/src/main/java/com/woniu/controller/ServiceCommentController.java @@ -4,6 +4,10 @@ import com.github.pagehelper.PageInfo; import com.woniu.common.CommonResult; import com.woniu.dto.ServiceCommentDTO; import com.woniu.service.ServiceCommentService; +import io.swagger.annotations.Api; +import io.swagger.annotations.ApiImplicitParam; +import io.swagger.annotations.ApiImplicitParams; +import io.swagger.annotations.ApiOperation; import org.apache.shiro.authz.annotation.RequiresPermissions; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Controller; @@ -13,7 +17,7 @@ import java.util.List; @Controller @RequestMapping("/service_comment") -@RequiresPermissions("sys:sc:list") +@Api(tags ="服务评论") public class ServiceCommentController { @Autowired @@ -27,6 +31,12 @@ public class ServiceCommentController { */ @RequestMapping("/list") @ResponseBody + @RequiresPermissions("sys:sc:list") + @ApiOperation(value = "分页查询") + @ApiImplicitParams({ + @ApiImplicitParam(name = "currentPage",value = "当前页数",defaultValue = "1"), + @ApiImplicitParam(name = "pageSize",value = "页面数据条数",defaultValue = "5") + }) public CommonResult list(@RequestParam(value = "page",defaultValue = "1",required = false)Integer currentPage, @RequestParam(value = "limit",defaultValue = "5",required = false)Integer pageSize){ PageInfo info=null; @@ -48,6 +58,8 @@ public class ServiceCommentController { @DeleteMapping("/delComment/{id}") @ResponseBody @RequiresPermissions("sys:sc:delete") + @ApiOperation(value = "删除评论") + @ApiImplicitParam(name = "id",value = "服务评论列表id",dataType = "Integer") public CommonResult delComment(@PathVariable("id")Integer id){ try { scService.delComment(id); @@ -66,9 +78,13 @@ public class ServiceCommentController { */ @RequestMapping("/select") @ResponseBody + @ApiOperation("页面查询") + @ApiImplicitParams({ + @ApiImplicitParam(name = "nickName",value = "用户名称"), + @ApiImplicitParam(name = "payName",value = "服务名称") + }) public CommonResult select(String nickName,String payName){ - System.out.println("nickName:"+nickName); - System.out.println("payName:"+payName); + PageInfo info=null; try { List list=scService.select(nickName,payName); diff --git a/pccenter/src/main/java/com/woniu/pojo/Admin.java b/pccenter/src/main/java/com/woniu/pojo/Admin.java index 2ad2fe5..fbe86bf 100644 --- a/pccenter/src/main/java/com/woniu/pojo/Admin.java +++ b/pccenter/src/main/java/com/woniu/pojo/Admin.java @@ -1,5 +1,7 @@ package com.woniu.pojo; +import io.swagger.annotations.ApiModel; + import java.util.Date; public class Admin { -- Gitee