swagger2 分组

https://blog.csdn.net/stonexmx/article/details/77604571

自定义注解

 package com.awj.mall.restfulapi.common.swagger.annotion;import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface ApiVersion {String[] group();}

创建版本常量类

package com.awj.mall.restfulapi.common.swagger.consts;public interface ApiVersionConsts {String V_2_2_1 = "v_2_2_1";}

3.改造swagger2生成文档类

package com.awj.mall.restfulapi.config;import java.util.Arrays;import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.context.request.async.DeferredResult;import com.awj.mall.restfulapi.common.swagger.annotion.ApiVersion;
import com.awj.mall.restfulapi.common.swagger.consts.ApiVersionConsts;
import com.google.common.base.Predicate;import io.swagger.annotations.ApiOperation;
import springfox.documentation.RequestHandler;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;@Configuration
public class Swagger2 {@Beanpublic Docket createRestApi() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)).paths(PathSelectors.any()).build();}//    @Bean
//  public Docket v2_2_1(){
//      return new Docket(DocumentationType.SWAGGER_2)
//              .apiInfo(apiInfo())
//              .groupName(ApiVersionConsts.V_2_2_1)
//              .select()
//              .apis(input -> {
//                  ApiVersion apiVersion = input.getHandlerMethod().getMethodAnnotation(ApiVersion.class);
//                  if(apiVersion!=null&& Arrays.asList(apiVersion.group()).contains(ApiVersionConsts.V_2_2_1)){
//                      return true;
//                  }
//                  return false;
//              })//controller路径
//              .paths(PathSelectors.any())
//              .build();
//  }@Beanpublic Docket v2_2_1(){return new Docket(DocumentationType.SWAGGER_2).groupName(ApiVersionConsts.V_2_2_1).genericModelSubstitutes(DeferredResult.class)
//              .genericModelSubstitutes(ResponseEntity.class).useDefaultResponseMessages(false).forCodeGeneration(false).select().apis(new Predicate<RequestHandler>() {@Overridepublic boolean apply(RequestHandler input) {ApiVersion apiVersion = input.getHandlerMethod().getMethodAnnotation(ApiVersion.class);if(apiVersion!=null&& Arrays.asList(apiVersion.group()).contains(ApiVersionConsts.V_2_2_1)){return true;}return false;}}).paths(PathSelectors.any())//过滤的接口.build().apiInfo(apiInfo());}/* @Beanpublic Docket packageApi() {return new Docket(DocumentationType.SWAGGER_2).groupName("app").apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage("com.awj.mall.restfulapi.modular")).paths(PathSelectors.any()).build();}*/private ApiInfo apiInfo() {return new ApiInfoBuilder().title("安万家-数据接口API").version("v1").build();}
}

4.利用注解进行swagger2分组

/*** 刷新个人信息(app端登入之后使用)* * @param requestApiParam* @return*/
@RequestMapping(value = "v1/getuserbaseinfo", method = RequestMethod.POST)
@ApiOperation(value = "刷新个人信息(app端登入之后使用)", notes = "一期一阶")
@ApiVersion(group= {ApiVersionConsts.V_2_2_1})
public ResultEntity<UserBaseInfoVO> getUserBaseInfo(@RequestBody RequestApiParam<EmptyDTO> requestApiParam) {assertUidNotNull(requestApiParam);UserBaseInfoVO userBaseInfoVO = new UserBaseInfoVO();UserBaseInfo userBaserInfo = this.userBaseInfoService.selectByUserId(HttpConsts.NO, HttpConsts.YES,requestApiParam.getUid());if (userBaserInfo == null) {return error(ResultCode.USER_NOT_EXIST);}BeanUtil.copyProperties(userBaserInfo, userBaseInfoVO);final String randomKey = jwtTokenUtil.getRandomKey();String jwtToken = jwtTokenUtil.generateToken(userBaseInfoVO.getId(), randomKey);// 设置jwtTokenuserBaseInfoVO.setRandomKey(randomKey);userBaseInfoVO.setAuthToken(jwtToken);userBaseInfoVO.setUserRole(UserUtil.getUserRoleByUserId(requestApiParam.getUid()));UserFirstpartyInfo userFirstpartyInfo = new UserFirstpartyInfo();if (UserConsts.SHOP_SERVICE.equals(userBaserInfo.getIdentity())) {List<UserFirstpartyInfo> userFirstpartyInfos = this.iUserFirstpartyInfoService.selectList(new EntityWrapper<UserFirstpartyInfo>().eq("is_deleted", HttpConsts.NO).eq("is_enable", HttpConsts.YES).eq("user_id", requestApiParam.getUid()).orderBy("created", false));if (userFirstpartyInfos != null && !userFirstpartyInfos.isEmpty()) {userFirstpartyInfo = userFirstpartyInfos.get(0);}}userBaseInfoVO.setUserFirstpartyInfo(userFirstpartyInfo);if (userBaserInfo.getpServiceUserId() != null) {UserBaseInfo pUserBaserInfo = this.userBaseInfoService.selectByUserId(HttpConsts.NO, HttpConsts.YES,userBaserInfo.getpServiceUserId());userBaseInfoVO.setpUserBaseInfo(pUserBaserInfo == null ? new UserBaseInfo() : pUserBaserInfo);}return success(userBaseInfoVO);
}

swagger2 分组相关推荐

[Swagger2]分组和接口注释及小结
分组和接口注释及小结配置API分组 1.如果没有配置分组,默认是default.通过groupName()方法即可配置分组: @Bean public Docket docket(Environme ...
swagger2的分组配置
当微服务的服务越来越多swagger2展示的越来越长这时候需要进行分页展示 swagger2头上有下拉框可以groupName进行分组展示 java代码代码: @Configuration @Enab ...
Swagger2 进行分组
Swagger是一个很好的api文档,如果我们的接口过于多,那么一个页面很难展示,查找不方便,那么我们就对swagger进行分组. 分组策略为按包名称分组,另一个是按请求路径进行分类. @Config ...
freemarker使用说明_SpringBoot+Swagger2集成详细说明
SpringBoot+Swagger2集成详细说明引言: 为什么使用Swagger? 在Vue没有出来之前,都是前后端在一起: 后端用的SSM或者SSH框架前端完全就是静态页面+模板引擎.例如:J ...
springmvc+swagger2
一.swagger2依赖  <dependency><groupId>io.springfox</groupId><a ...
Java效率工具之Swagger2
现代化的研发组织架构中,一个研发团队基本包括了产品组.后端组.前端组.APP端研发.测试组.UI组等,各个细分组织人员各司其职,共同完成产品的全周期工作.如何进行组织架构内的有效高效沟通就显得尤其重要 ...
SpringBoot集成Swagger2自动生成友好的RestApi测试页面及文档
springBoot集成swagger2 水煮鱼又失败了 https://www.jianshu.com/p/002ce2f26103 1 背景 springBoot作为微服务首选框架,为其他服务提供 ...
SpringBoot+Swagger2
SpringBoot与Swagger2整合依赖: <dependencies><dependency><groupId>org.springframework.b ...
swagger2 注解
刚开始的时候,在controller层使用@RequestParam的时候,发现这个参数是必须要输入值的,但是我们有时候必须查询的时候允许参数为空,使用这个注解就不行了. 在集成了swagger2后, ...

swagger2 分组

swagger2 分组相关推荐

最新文章

热门文章