Swagger2 | 02. 多人开发:API分组

0. 使用的项目名字:test_spring_boot

模块名字:test_swagger

传送门 == 》码云仓库

1. 应用场景:分组开发

比如A这个模块由XYX开发
然而B这个模块由SHR开发
为了对二位开发的内容进行区分,便需要分组

在swagger就可以针对这种情况,分别查看A、B开发的这部分代码的接口
在这里插入图片描述

2. 配置:一个组对应一个docket

先附上docket的代码:

//  --03.配置swagger的docket-----------------------------------------------------------------------------
   @Bean
   //参数environment表示当前的环境
   public Docket docketForXYX(Environment environment) {
      //你负责的这个Artifact的名字
      String artifactName = "test_swagger";

      return new Docket(DocumentationType.SWAGGER_2).
            apiInfo(apiInfoForXYX())
            //设置组名
            .groupName("XYX")
            //通过environment.acceptProfiles判断目前是否处在profiles中设定的环境之下
            //如果是,返回true,则会开启swagger
            .enable(environment.acceptsProfiles(profiles))
            //指定要扫描的包,一般是controller包
            .select().apis(RequestHandlerSelectors.basePackage("com.eshang." + artifactName + ".controller"))
            .build();
   }

重点看下面的代码

 			apiInfo(apiInfoForXYX())
 			//设置组名
 			.groupName("XYX")

(1)一个docket对应一个apiInfo(这个接口文档的信息)

(2)一个docket对应一个groupName(小组名)

因此,分组开发的思路是:
一组一个docket,分别配置好对应的apiInfo和groupName即可

  • 1
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值