swagger

business-common/src/main/java/com/rongwei/bscommon/sys/config/SwaggerConfig.java

@@ -1,5 +1,7 @@
 package com.rongwei.bscommon.sys.config;
 
+import io.swagger.annotations.Api;
+import org.springframework.beans.factory.annotation.Value;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import springfox.documentation.builders.ApiInfoBuilder;
@@ -13,13 +15,17 @@ import springfox.documentation.swagger2.annotations.EnableSwagger2;
 @Configuration // 标明是配置类
 @EnableSwagger2 //开启swagger功能
 public class SwaggerConfig {
+    @Value("${swagger.enable:false}")
+    private Boolean enable;
+
     @Bean
     public Docket createRestApi() {
-        return new Docket(DocumentationType.SWAGGER_2)  // DocumentationType.SWAGGER_2 固定的，代表swagger2
+        return new Docket(DocumentationType.SWAGGER_2).enable(enable)  // DocumentationType.SWAGGER_2 固定的，代表swagger2
 //                .groupName("分布式任务系统") // 如果配置多个文档的时候，那么需要配置groupName来分组标识
                 .apiInfo(apiInfo()) // 用于生成API信息
                 .select() // select()函数返回一个ApiSelectorBuilder实例,用来控制接口被swagger做成文档
-                .apis(RequestHandlerSelectors.basePackage("com.rongwei.bsserver.controller")) // 用于指定扫描哪个包下的接口
+                //.apis(RequestHandlerSelectors.basePackage("com.rongwei.bsserver.controller")) // 用于指定扫描哪个包下的接口
+                .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
                 .paths(PathSelectors.any())// 选择所有的API,如果你想只为部分API生成文档，可以配置这里
                 .build();
     }

business-server/src/main/java/com/rongwei/bsserver/controller/ZhcxApiController.java

@@ -6,6 +6,10 @@ import com.rongwei.bscommon.sys.service.ZhcxApiService;
 import com.rongwei.bscommon.sys.utils.HwSmsUtil;
 import com.rongwei.bsentity.vo.ZhcxOutsideInspectionVo;
 import com.rongwei.rwcommon.base.R;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiImplicitParam;
+import io.swagger.annotations.ApiImplicitParams;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestBody;
@@ -22,12 +26,17 @@ import java.util.Random;
  */
 @RestController
 @RequestMapping("/zhcxApi")
+@Api(tags = "接口相关",description = "公共接口")
 public class ZhcxApiController {
 
     @Autowired
     private ZhcxApiService zhcxApiService;
 
     @PostMapping("/getOutsideInspectionList")
+    @ApiOperation("根据项目查看外部报验清单")
+    @ApiImplicitParams({
+            @ApiImplicitParam(name = "projectcode", value = "项目工号", dataType = "string")
+    })
     public R getOutsideInspectionList(@RequestBody Map<String,Object> map){
         if(!map.containsKey("projectcode")){
             return R.error("projectcode参数必填");
@@ -37,6 +46,12 @@ public class ZhcxApiController {
     }
 
     @PostMapping("/sendCode")
+    @ApiOperation("发送验证码")
+    @ApiImplicitParams({
+            @ApiImplicitParam(name = "loginType",required = true, value = "入口(PC/YD)", dataType = "string"),
+            @ApiImplicitParam(name = "account",required = true, value = "账号", dataType = "string"),
+            @ApiImplicitParam(name = "password",required = true, value = "密码", dataType = "string")
+    })
     public R sendCode(@RequestBody Map<String,Object> map){
         R r = zhcxApiService.sendCode(map);
         return r;
@@ -61,6 +76,10 @@ public class ZhcxApiController {
     }
 
     @PostMapping("/getCoreInspectionDetailList")
+    @ApiOperation("核心检验指标预览")
+    @ApiImplicitParams({
+            @ApiImplicitParam(name = "ID",required = true, value = "核心检验指标预览ID", dataType = "string")
+    })
     public R getCoreInspectionDetailList(@RequestBody Map<String,Object> map){
         R r = zhcxApiService.getCoreInspectionDetailList(map);
         return r;

business-server/src/main/java/com/rongwei/bsserver/controller/ZhcxLoginController.java

@@ -11,6 +11,10 @@ import com.rongwei.rwadmincommon.system.domain.UserLoginVo;
 import com.rongwei.rwadmincommon.system.vo.SysUserVo;
 import com.rongwei.rwcommon.base.R;
 import com.rongwei.rwcommon.utils.SecurityUtil;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiImplicitParam;
+import io.swagger.annotations.ApiImplicitParams;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.transaction.annotation.Transactional;
 import org.springframework.web.bind.annotation.PostMapping;
@@ -25,6 +29,7 @@ import java.util.Map;
  */
 @RestController
 @RequestMapping("/sysLogin")
+@Api(tags = "登录")
 public class ZhcxLoginController {
 
 
@@ -33,6 +38,13 @@ public class ZhcxLoginController {
 
     @PostMapping("loginIn")
     @Transactional()
+    @ApiOperation("用户登录")
+    @ApiImplicitParams({
+            @ApiImplicitParam(name = "loginType",required = true, value = "入口(PC/YD)", dataType = "string"),
+            @ApiImplicitParam(name = "account",required = true, value = "账号", dataType = "string"),
+            @ApiImplicitParam(name = "password",required = true, value = "密码", dataType = "string"),
+            @ApiImplicitParam(name = "code",required = true, value = "验证码", dataType = "string")
+    })
     public R loginIn(@RequestBody Map<String,Object> map){
         R r = zhcxLoginService.loginIn(map);
         return r;

business-server/src/main/java/com/rongwei/bsserver/controller/ZhcxPersistentController.java

@@ -4,6 +4,8 @@ import com.rongwei.bscommon.sys.service.ZhcxPersistentManageService;
 import com.rongwei.bscommon.sys.service.ZhcxPersistentService;
 import com.rongwei.rwcommon.base.R;
 import com.rongwei.rwcommon.base.exception.CustomException;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestBody;
@@ -18,12 +20,14 @@ import java.util.Map;
  */
 @RestController
 @RequestMapping("/zhcxPersistent")
+@Api(tags = "顽症管理")
 public class ZhcxPersistentController {
 
     @Autowired
     private ZhcxPersistentManageService zhcxPersistentManageService;
 
     @PostMapping("wordExport")
+    @ApiOperation("word导出")
     public void wordExport(@RequestBody Map<String,Object> map, HttpServletResponse response){
         int i = zhcxPersistentManageService.wordExport(map,response);
         if(i == 0){

business-server/src/main/java/com/rongwei/bsserver/controller/ZhcxQualityAwardController.java

@@ -4,6 +4,8 @@ import com.rongwei.bscommon.sys.service.OutSourceService;
 import com.rongwei.bscommon.sys.service.ZhcxQualityAwardService;
 import com.rongwei.bsentity.domain.ZhcxQualityAwardBaseInfoDo;
 import com.rongwei.rwcommon.base.R;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestBody;
@@ -18,6 +20,7 @@ import java.util.List;
  */
 @RestController
 @RequestMapping("/zhcxQualityAward")
+@Api(tags = "质量奖罚条例库")
 public class ZhcxQualityAwardController {
 
     @Autowired
@@ -28,6 +31,7 @@ public class ZhcxQualityAwardController {
      * @return
      */
     @PostMapping("/copyData")
+    @ApiOperation("复制新增")
     public R copyData(@RequestBody ZhcxQualityAwardBaseInfoDo zcxQualityAwardBaseInfoDo){
         zhcxQualityAwardService.copyData(zcxQualityAwardBaseInfoDo);
         return R.ok();

business-server/src/main/java/com/rongwei/bsserver/controller/ZhcxRegisterController.java

@@ -4,6 +4,8 @@ import com.alibaba.fastjson.JSONObject;
 import com.rongwei.bscommon.sys.service.ZhcxRegisterService;
 import com.rongwei.bsentity.domain.ZhcxSupervisionCustomUserManageDo;
 import com.rongwei.rwcommon.base.R;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestBody;
@@ -18,24 +20,28 @@ import java.util.Map;
  */
 @RestController
 @RequestMapping("/zhcxRegister")
+@Api(tags = "移动端注册",description = "注册审批")
 public class ZhcxRegisterController {
 
     @Autowired
     private ZhcxRegisterService zhcxRegisterService;
 
     @PostMapping("/supervisionRegister")
+    @ApiOperation("注册用户")
     public R supervisionRegister(@RequestBody JSONObject jsonObject){
         R r = zhcxRegisterService.supervisionRegister(jsonObject);
         return r;
     }
 
     @PostMapping("/sendCode")
+    @ApiOperation("发送验证码")
     public R sendCode(@RequestBody Map<String,Object> map){
         R r = zhcxRegisterService.sendCode(map);
         return r;
     }
 
     @PostMapping("/checkSupervisionUser")
+    @ApiOperation("监理用户注册审批通过")
     public R checkSupervisionUser(@RequestBody List<ZhcxSupervisionCustomUserManageDo> list){
         R r = zhcxRegisterService.checkSupervisionUser(list);
         return r;

business-server/src/main/java/com/rongwei/bsserver/controller/ZhcxSubcontractorUserController.java

@@ -17,7 +17,7 @@ import java.util.List;
  * @author zhuang
  * 分包商账号
  */
-@Api("分包商监理接口")
+@Api(tags = "分包商监理接口",description = "新增用户")
 @RestController
 @RequestMapping("/zhcxSubcontractorUser")
 public class ZhcxSubcontractorUserController {