springboot swagger 接口文档分组展示功能实现

 更新时间:2024年03月27日 10:14:01   作者:狄龙疤  
这篇文章主要介绍了springboot swagger 接口文档分组展示功能实现,本文通过实例代码给大家介绍的非常详细,感兴趣的朋友跟随小编一起看看吧

例如将 controller 分成四类,分别放到四个包下:

        
xxx.xxx.xxx.controller.manage
xxx.xxx.xxx.controller.client
xxx.xxx.xxx.controller.authority
xxx.xxx.xxx.controller.common

SwaggerConfig.java:

import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
@RefreshScope
@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Value("${system.swagger_show}")
    private boolean swaggerShow;
     @Bean
    public Docket manageGroup() {
        return this.buildDocket( "管理端接口","xxx.xxx.xxx.controller.manage" );
    }
    @Bean
    public Docket clientGroup() {
        return this.buildDocket( "移动端接口","xxx.xxx.xxx.controller.client" );
    }
    @Bean
    public Docket authorityGroup() {
        return this.buildDocket( "权限相关接口","xxx.xxx.xxx.controller.authority" );
    }
    @Bean
    public Docket commonGroup() {
        return this.buildDocket( "数据字典、行政区域公共接口","xxx.xxx.xxx.controller.common" );
    }
    private Docket buildDocket( String groupName,String basePackage ){
        return new Docket(DocumentationType.SWAGGER_2)
                    .groupName( groupName )
                    .enable(this.swaggerShow)
                    .produces(Collections.singleton(MediaType.APPLICATION_JSON_VALUE))
                    .genericModelSubstitutes(ResponseEntity.class)
                    .forCodeGeneration(false)
                    .useDefaultResponseMessages(false)
                    .pathMapping("/")
                    .select()
                    .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                    .apis(RequestHandlerSelectors.basePackage( basePackage ))
                    .paths(PathSelectors.any())
                    .build()
                    .globalOperationParameters( setHeaderToken() )
                    .directModelSubstitute(java.sql.Timestamp.class, java.sql.Date.class)
                    .apiInfo(apiInfo());
    }
    private List<Parameter> setHeaderToken() {
        ParameterBuilder tokenPar = new ParameterBuilder();
        List<Parameter> pars = new ArrayList<>();
        tokenPar.name("witToken").description("登录token").modelRef(new ModelRef("string")).parameterType("header").required(false).build();
        pars.add(tokenPar.build());
        return pars;
    }
    private ApiInfo apiInfo() {
        ApiInfo apiInfo = new ApiInfoBuilder()
                .title("xxx系统( xxx) API")
                .description("xxx系统( xxx) API")
                .license(null)
                .licenseUrl(null)
                .contact(new Contact("developer", "", "developer@xxx.com"))
                .version("1.0")
                .build();
        return apiInfo;
    }
}
 

效果:

到此这篇关于springboot swagger 接口文档分组展示的文章就介绍到这了,更多相关springboot swagger 接口文档内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java 函数编程详细介绍

    Java 函数编程详细介绍

    这篇文章主要介绍了Java函数式编程,lambda表达式可以被认为是一个匿名函数,可以在函数接口的上下文中使用。函数接口是只指定一个抽象方法的接口,下面来看文章的详细内容,需要的朋友可以参考下
    2021-11-11
  • IDEA 2020版本最新破解教程可激活至2089年(推荐)

    IDEA 2020版本最新破解教程可激活至2089年(推荐)

    这篇文章主要介绍了IDEA 2020版本最新破解教程可激活至2089年,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-09-09
  • java关键字static的使用详解

    java关键字static的使用详解

    这篇文章主要介绍了java关键字static的使用详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-08-08
  • java web将数据导出为pdf格式文件代码片段

    java web将数据导出为pdf格式文件代码片段

    这篇文章主要为大家详细介绍了java web将数据导出为pdf格式文件代码片段,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-01-01
  • MybatisPlus整合Flowable出现的坑及解决

    MybatisPlus整合Flowable出现的坑及解决

    这篇文章主要介绍了MybatisPlus整合Flowable出现的坑及解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-03-03
  • 详解SpringSecurity中的Authentication信息与登录流程

    详解SpringSecurity中的Authentication信息与登录流程

    这篇文章主要介绍了SpringSecurity中的Authentication信息与登录流程,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-09-09
  • springboot+feign+Hystrix整合(亲测有效)

    springboot+feign+Hystrix整合(亲测有效)

    本文主要介绍了springboot+feign+Hystrix整合,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-11-11
  • 面向切面的Spring通过切点来选择连接点实例详解

    面向切面的Spring通过切点来选择连接点实例详解

    这篇文章主要为大家介绍了面向切面的Spring通过切点来选择连接点实例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-10-10
  • mybatis-plus 使用Condition拼接Sql语句各方法的用法

    mybatis-plus 使用Condition拼接Sql语句各方法的用法

    这篇文章主要介绍了mybatis-plus 使用Condition拼接Sql语句各方法的用法,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-07-07
  • Springboot源码 TargetSource解析

    Springboot源码 TargetSource解析

    这篇文章主要介绍了Springboot源码 TargetSource解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-08-08

最新评论