springboot如何集成Swagger2

 更新时间:2020年12月18日 11:29:28   作者:Tom-shushu  
这篇文章主要介绍了springboot集成Swagger2的方法,帮助大家更好的理解和使用springboot框架,感兴趣的朋友可以了解下

一、是什么

  当下很多公司都采取前后端分离的开发模式,前端和后端的工作由不同的工程师完成。在这种开发模式下,维持一份及时更新且完整的 Rest API 文档将会极大的提高我们的工作效率。传统意义上的文档都是后端开发人员手动编写的,相信大家也都知道这种方式很难保证文档的及时性,这种文档久而久之也就会失去其参考意义,反而还会加大我们的沟通成本。而 Swagger 给我们提供了一个全新的维护 API 文档的方式。

二、为什么要使用它

  1、代码变更,文档跟着代码变、只需要少量的注解Swagger就可以根据代码自动的生成API文档,很好的保证了文档的实时性。

  2、跨语言,Swagger支持40多种语言。

  3、Swagger UI 呈现出来的是一份可以交互的API文档,我们可以直接在文档页面尝试API的调用,省去了准备复杂的调用参数的过程。

  4、还可以将文档规范导入相关的工具里面(例如:Postman、SoapUI)、这些工具将会为我们自动地创建自动化测试。

三、怎么用

  1、在项目pom.xml里面加入Swagger2相关的依赖

<!--swagger2配置-->
    <dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger-ui</artifactId>
      <version>2.4.0</version>
    </dependency>
    <dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger2</artifactId>
      <version>2.4.0</version>
    </dependency>
    <dependency>
      <groupId>com.github.xiaoymin</groupId>
      <artifactId>swagger-bootstrap-ui</artifactId>
      <version>1.6</version>
    </dependency>

  2、新建Swagger2的配置类

package com.zhouhong.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
/**
 * @ClassName: Swagger2
 * @Description:
 * @Author: 周红
 * @NickName: Tom-shuhu
 * @Date: Created in 2020/12/15
 **/
@Configuration
@EnableSwagger2
public class Swagger2 {
  //  http://localhost:8088/swagger-ui.html 原路径
  //  http://localhost:8088/doc.html 原路径
  //配置swagger2核心配置
  @Bean
  public Docket createRestApi(){
    return new Docket(DocumentationType.SWAGGER_2) //指定api类型位swagger2
      .apiInfo(apiInfo())            //用于定义api文档汇总信息
        .select().apis(RequestHandlerSelectors
            .basePackage("com.zhouhong.controller")) //指定生成文档的controller
        .paths(PathSelectors.any())      
        .build();
  }
  private ApiInfo apiInfo(){
    return new ApiInfoBuilder()
        .title("Tom-shushu 的项目接口api") //文档标题
        .contact(new Contact("周红", //作者
            "www.zhouhong.icu",  
            "15249239025@163.com")) //联系人
        .description("Tom-shushu 的项目api接口")//详细信息
        .version("1.0.0")//文档版本号
        .termsOfServiceUrl("www.zhouhong.icu")//网站地址
        .build();
  }
}

  文档配置说明:

  a.为任何接口生成API文档,这种方式不必在接口方法上加任何注解,方便的同时也会因为没有添加任何注解所以生成的API文档也没有注释,可读性不高。

@Bean
  public Docket createRestApi(){
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .select()
        //为任何接口生成API文档
        .apis(RequestHandlerSelectors.any())
        .paths(PathSelectors.any())
        .build();
  }

  b.为当前配置的包下controller生成API文档

.apis(RequestHandlerSelectors.basePackage("com.troila"))

  c.为有@Api注解的Controller生成API文档

.apis(RequestHandlerSelectors.withClassAnnotation(Api.class))

  d.为有@ApiOperation注解的方法生成API文档

.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))

三、常见注解简介

@Api:修饰整个类,描述Controller的作用
 @ApiOperation:描述一个类的一个方法,或者说一个接口
 @ApiParam:单个参数描述
 @ApiModel:用对象实体来作为入参
 @ApiProperty:用对象接实体收参数时,描述对象的一个字段
 @ApiResponse:HTTP响应其中1个描述
 @ApiResponses:HTTP响应整体描述
 @ApiIgnore:使用该注解忽略这个API
 @ApiError :发生错误返回的信息
 @ApiImplicitParam:一个请求参数
 @ApiImplicitParams: 多个请求参数

四、演示(为方便我使用了上面第一种配置)

  1、使用原路径访问

   2、原路径调试

  3、doc模式访问

       4、doc模式调试

以上就是springboot集成Swagger2的详细内容,更多关于springboot集成Swagger2的资料请关注脚本之家其它相关文章!

相关文章

  • Java使用正则表达式获取子文本的方法示例

    Java使用正则表达式获取子文本的方法示例

    这篇文章主要介绍了Java使用正则表达式获取子文本的方法,结合实例形式分析了java针对子文本的正则操作相关函数与使用技巧,需要的朋友可以参考下
    2017-09-09
  • logback使用filter过滤日志操作

    logback使用filter过滤日志操作

    这篇文章主要介绍了logback使用filter过滤日志操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-09-09
  • java实现excel导入数据的工具类

    java实现excel导入数据的工具类

    这篇文章主要介绍了java实现的excel导入数据的工具类,需要的朋友可以参考下
    2014-03-03
  • 通过实例解析Java class文件编译加载过程

    通过实例解析Java class文件编译加载过程

    这篇文章主要介绍了通过实例解析Java class文件编译加载过程,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-07-07
  • Java Poi 在Excel中输出特殊符号的实现方法

    Java Poi 在Excel中输出特殊符号的实现方法

    这篇文章主要介绍了Java Poi 在Excel中输出特殊符号的实现方法,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-07-07
  • 解决IDEA中maven导入jar包一直报错问题

    解决IDEA中maven导入jar包一直报错问题

    这篇文章主要介绍了解决IDEA中maven导入jar包一直报错问题,本文通过实例图文的形式给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-04-04
  • springboot中不能获取post请求参数的解决方法

    springboot中不能获取post请求参数的解决方法

    这篇文章主要介绍了springboot中不能获取post请求参数的解决方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-06-06
  • SpringBoot打War包上传到阿里云的LINUX服务器的操作方法

    SpringBoot打War包上传到阿里云的LINUX服务器的操作方法

    这篇文章主要介绍了SpringBoot打War包上传到阿里云的LINUX服务器,本文通过图文并茂的形式给大家介绍的非常详细,具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-02-02
  • Spring+SpringMVC+Hibernate整合实例讲解

    Spring+SpringMVC+Hibernate整合实例讲解

    在本篇文章里小编给大家整理的是关于Spring+SpringMVC+Hibernate整合实例讲解,需要的朋友们可以学习下。
    2020-03-03
  • springboot实现上传并解析Excel过程解析

    springboot实现上传并解析Excel过程解析

    这篇文章主要介绍了springboot实现上传并解析Excel过程解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-09-09

最新评论