Swagger3.0，你所不知道的新变化！

在社区的推动下，Springfox3.0 去年 7 月份就发布了，最近终于得空和小伙伴们聊一聊新版本的新变化。这次的版本升级估计小伙伴们都翘首以待好久了，毕竟上一次发版已经是两年前的事情了。

成都创新互联一直秉承“诚信做人，踏实做事”的原则，不欺瞒客户，是我们最起码的底线！以服务为基础，以质量求生存，以技术求发展，成交一个客户多一个朋友！为您提供网站设计、成都网站建设、成都网页设计、成都小程序开发、成都网站开发、成都网站制作、成都软件开发、成都app软件开发公司是成都本地专业的网站建设和网站设计公司，等你一起来见证！

新版本还是有很多好玩的地方，我们一起来看下。

支持 OpenAPI

什么是 OpenAPI?

OpenAPI 规范其实就是以前的 Swagger 规范，它是一种 REST API 的描述格式，通过既定的规范来描述文档接口，它是业界真正的 API 文档标准，可以通过 YAML 或者 JSON 来描述。它包括如下内容：

接口(/users)和每个接口的操作(GET /users，POST /users)
输入参数和响应内容
认证方法
一些必要的联系信息、license 等。

关于 OpenAPI 的更多内容，感兴趣的小伙伴可以在 GitHub 上查看：https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md

依赖

以前在使用 2.9.2 这个版本的时候，一般来说我们可能需要添加如下两个依赖：

 
 
 
 
  
  
  
  
  
  
  
      io.springfox
  
  
  
      springfox-swagger2
  
  
  
      2.9.2
  
  
  
  
  
  
  
  
  
  
  
      io.springfox
  
  
  
      springfox-swagger-ui
  
  
  
      2.9.2

这两个，一个用来生成接口文档(JSON 数据)，另一个用来展示将 JSON 可视化。

在 3.0 版本中，我们不需要这么麻烦了，一个 starter 就可以搞定：

 
 
 
 
  
  
  
  
  
  
  
      io.springfox
  
  
  
      springfox-boot-starter
  
  
  
      3.0.0

和 Spring Boot 中的其他 starter 一样，springfox-boot-starter 依赖可以实现零配置以及自动配置支持。也就是说，如果你没有其他特殊需求，加一个这个依赖就行了，接口文档就自动生成了。

接口地址

3.0 中的接口地址也和之前有所不同，以前在 2.9.2 中我们主要访问两个地址：

文档接口地址：http://localhost:8080/v2/api-docs
文档页面地址：http://localhost:8080/swagger-ui.html

现在在 3.0 中，这两个地址也发生了变化：

文档接口地址：http://localhost:8080/v3/api-docs
文档页面地址：http://localhost:8080/swagger-ui/index.html

特别是文档页面地址，如果用了 3.0，而去访问之前的页面，会报 404。

注解旧的注解还可以继续使用，不过在 3.0 中还提供了一些其他注解。

例如我们可以使用 @EnableOpenApi 代替以前旧版本中的 @EnableSwagger2。

话是这么说，不过松哥在实际体验中，感觉 @EnableOpenApi 注解的功能不明显，加不加都行。翻了下源码，@EnableOpenApi 注解主要功能是为了导入 OpenApiDocumentationConfiguration 配置类，如下：

 
 
 
 
  
  
  
  @Retention(value = java.lang.annotation.RetentionPolicy.RUNTIME)
  
  
  
  @Target(value = {java.lang.annotation.ElementType.TYPE})
  
  
  
  @Documented
  
  
  
  @Import(OpenApiDocumentationConfiguration.class)
  
  
  
  public @interface EnableOpenApi {
  
  
  
  }

然后我又看了下自动化配置类 OpenApiAutoConfiguration，如下：

 
 
 
 
  
  
  
  @Configuration
  
  
  
  @EnableConfigurationProperties(SpringfoxConfigurationProperties.class)
  
  
  
  @ConditionalOnProperty(value = "springfox.documentation.enabled", havingValue = "true", matchIfMissing = true)
  
  
  
  @Import({
  
  
  
      OpenApiDocumentationConfiguration.class,
  
  
  
      SpringDataRestConfiguration.class,
  
  
  
      BeanValidatorPluginsConfiguration.class,
  
  
  
      Swagger2DocumentationConfiguration.class,
  
  
  
      SwaggerUiWebFluxConfiguration.class,
  
  
  
      SwaggerUiWebMvcConfiguration.class
  
  
  
  })
  
  
  
  @AutoConfigureAfter({ WebMvcAutoConfiguration.class, JacksonAutoConfiguration.class,
  
  
  
      HttpMessageConvertersAutoConfiguration.class, RepositoryRestMvcAutoConfiguration.class })
  
  
  
  public class OpenApiAutoConfiguration {
  
  
  
  
  
  
  
  }

可以看到，自动化配置类里边也导入了 OpenApiDocumentationConfiguration。

所以在正常情况下，实际上不需要添加 @EnableOpenApi 注解。

根据 OpenApiAutoConfiguration 上的 @ConditionalOnProperty 条件注解中的定义，我们发现，如果在 application.properties 中设置 springfox.documentation.enabled=false，即关闭了 swagger 功能，此时自动化配置类就不执行了，这个时候可以通过 @EnableOpenApi 注解导入 OpenApiDocumentationConfiguration 配置类。技术上来说逻辑是这样，不过应用中暂未发现这样的需求(即在 application.properties 中关闭 swagger，再通过 @EnableOpenApi 注解开启)。

本文转载自微信公众号「江南一点雨」，可以通过以下二维码关注。转载本文请联系江南一点雨公众号。

当前文章：Swagger3.0，你所不知道的新变化！
转载来源：http://www.mswzjz.cn/qtweb/news2/536602.html

攀枝花网站建设、攀枝花网站运维推广公司-贝锐智能，是专注品牌与效果的网络营销公司；服务项目有等

声明：本网站发布的内容（图片、视频和文字）以用户投稿、用户转载内容为主，如果涉及侵权请尽快告知，我们将会在第一时间删除。文章观点不代表本网站立场，如需处理请联系客服。电话：028-86922220；邮箱：631063699@qq.com。内容未经允许不得转载，或转载时需注明来源：贝锐智能

贝锐智能技术为您推荐以下文章