SpringBoot整合Swagger2代码实例

 更新时间:2020年03月04日 11:03:50   作者:赵小胖0914  
这篇文章主要介绍了SpringBoot整合Swagger2代码实例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下

首先遵循SpringBoot的三板斧

第一步添加依赖

<!-- SwaggerUI 接口文档 http://{ip}:{prot}/swagger-ui.html -->
<dependency>
  <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger2</artifactId>
     <version>{version}</version>
</dependency>
<dependency>
  <groupId>io.springfox</groupId>
     <artifactId>springfox-swaggerui</artifactId>
  <version>{version}</version>
</dependency>

第二步添加注解

@EnableSwagger2 //启动SwaggerUI,在启动类或Swagger配置类上添加该注解

第三步写配置

@Configuration
@EnableSwagger2
public class SwaggerConfig {

  @Bean
  public Docket api() {

/*
    //可以添加多个header或参数
    ParameterBuilder aParameterBuilder = new ParameterBuilder();
    aParameterBuilder
        //参数类型支持header, cookie, body, query etc
        .parameterType("header")
        //参数名
        .name("user-token")
        //默认值
        .defaultValue("t122222")
        .description("用户登录凭证")
        //指定参数值的类型
        .modelRef(new ModelRef("string"))
        //非必需,这里是全局配置
        .required(false).build();
    List<Parameter> aParameters = new ArrayList<>();
    aParameters.add(aParameterBuilder.build());
*/

    return new Docket(DocumentationType.SWAGGER_2)
//    return new Docket(DocumentationType.SPRING_WEB)
        .apiInfo(apiInfo())
        .pathMapping("/")
        .select()// 选择那些路径和api会生成document
        .apis(RequestHandlerSelectors.any())// 对所有api进行监控
        // 不显示错误的接口地址
        .paths(Predicates.not(PathSelectors.regex("/error.*")))// 错误error路径不监控
        .paths(Predicates.not(PathSelectors.regex("/actuator.*")))// 错误error路径不监控
        .paths(PathSelectors.regex("/.*"))// 对根下所有路径进行监控
        .paths(PathSelectors.any())  // 对所有路径进行监控
        // 自行修改为自己的包路径
//        .apis(RequestHandlerSelectors.basePackage("com.happyloves.zc.service.account.api"))
        .build()
//        .globalOperationParameters(aParameters)
        .enable(true);
  }

  private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
        .title("API接口")
        .description("API接口文档")
        //服务条款网址
//        .termsOfServiceUrl("https://www.google.com")
        .version("1.0")
//        .contact(new Contact("啦啦啦", "url", "email"))
        .build();
  }
}

扩展:swagger-bootstrap-ui是springfox-swagger的增强UI实现,为Java开发者在使用Swagger的时候,能拥有一份简洁、强大的接口文档

体验项目地址码云:https://gitee.com/xiaoym/swagger-bootstrap-ui

GitHub: https://github.com/xiaoymin/Swagger-Bootstrap-UI

在线体验:http://swagger-bootstrap-ui.xiaominfo.com/doc.html

代码集成示例

SpringBoot在线demo地址:https://gitee.com/xiaoym/swagger-bootstrap-ui-demo

Spring Mvc在线demo地址:https://gitee.com/xiaoym/swagger-bootstrap-ui-demo/tree/master/swagger-bootstrap-ui-demo-mvc

添加依赖

<!-- swagger-bootstrap-ui是 Swagger 的增强UI 实现,使文档更友好一点儿 http://{ip}:{prot}/doc.html -->
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>swagger-bootstrap-ui</artifactId>
<version>1.9.6</version>
</dependency>

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。

相关文章

  • Jenkins的安装配置详解

    Jenkins的安装配置详解

    这篇文章主要介绍了Jenkins的安装配置详解,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-06-06
  • mybatis-plus动态数据源读写分离方式

    mybatis-plus动态数据源读写分离方式

    在分布式项目开发中,动态数据源的配置与使用至关重要,通过创建DynamicDatasourceService,实现数据源的动态添加与调用,有效管理主从库操作,减轻数据库压力,此外,通过配置类与@DS注解,实现了灵活的分库查询功能,为高效处理数据提供了强有力的支持
    2024-10-10
  • Java数据结构之简单的连接点(link)实现方法示例

    Java数据结构之简单的连接点(link)实现方法示例

    这篇文章主要介绍了Java数据结构之简单的连接点(link)实现方法,涉及java指针指向节点的相关使用技巧,需要的朋友可以参考下
    2017-10-10
  • IDEA使用maven创建hibernate项目的实现步骤(图文)

    IDEA使用maven创建hibernate项目的实现步骤(图文)

    本文主要介绍了IDEA使用maven创建hibernate项目的实现步骤,包括创建Maven项目,配置Hibernate,以及创建实体类映射到数据库等步骤,具有一定的参考价值,感兴趣的可以了解一下
    2023-08-08
  • 用Java实现简单计算器功能

    用Java实现简单计算器功能

    这篇文章主要为大家详细介绍了用Java实现简单计算器功能,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-07-07
  • SpringBoot中使用MyBatis-Plus实现分页接口的详细教程

    SpringBoot中使用MyBatis-Plus实现分页接口的详细教程

    MyBatis-Plus是一个MyBatis的增强工具,在MyBatis的基础上只做增强不做改变,为简化开发、提高效率而生,在SpringBoot项目中使用MyBatis-Plus可以大大简化分页逻辑的编写,本文将介绍如何在 SpringBoot项目中使用MyBatis-Plus实现分页接口
    2024-03-03
  • Java使用选择排序法对数组排序实现代码

    Java使用选择排序法对数组排序实现代码

    这篇文章主要介绍了Java使用选择排序法对数组排序实现代码,需要的朋友可以参考下
    2014-02-02
  • ibatis迁移到mybatis3的注意事项

    ibatis迁移到mybatis3的注意事项

    这篇文章主要介绍了ibatis迁移到mybatis3的注意事项的相关资料,需要的朋友可以参考下
    2017-10-10
  • java 后端生成pdf模板合并单元格表格的案例

    java 后端生成pdf模板合并单元格表格的案例

    这篇文章主要介绍了java 后端生成pdf模板合并单元格表格的案例,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2021-01-01
  • Java 迪杰斯特拉算法实现查找最短距离的实现

    Java 迪杰斯特拉算法实现查找最短距离的实现

    这篇文章主要介绍了Java 迪杰斯特拉算法实现查找最短距离的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-09-09

最新评论