建站
咨詢(xún)
售后
建站咨詢(xún)
新聞中心
在社區(qū)的推動(dòng)下，Springfox3.0 去年 7 月份就發(fā)布了，最近終于得空和小伙伴們聊一聊新版本的新變化。這次的版本升級(jí)估計(jì)小伙伴們都翹首以待好久了，畢竟上一次發(fā)版已經(jīng)是兩年前的事情了。
成都創(chuàng)新互聯(lián)一直秉承“誠(chéng)信做人，踏實(shí)做事”的原則，不欺瞞客戶，是我們最起碼的底線！ 以服務(wù)為基礎(chǔ)，以質(zhì)量求生存，以技術(shù)求發(fā)展，成交一個(gè)客戶多一個(gè)朋友！為您提供網(wǎng)站設(shè)計(jì)、成都網(wǎng)站建設(shè)、成都網(wǎng)頁(yè)設(shè)計(jì)、成都小程序開(kāi)發(fā)、成都網(wǎng)站開(kāi)發(fā)、成都網(wǎng)站制作、成都軟件開(kāi)發(fā)、成都app軟件開(kāi)發(fā)公司是成都本地專(zhuān)業(yè)的網(wǎng)站建設(shè)和網(wǎng)站設(shè)計(jì)公司，等你一起來(lái)見(jiàn)證！
新版本還是有很多好玩的地方，我們一起來(lái)看下。
支持 OpenAPI
什么是 OpenAPI?
OpenAPI 規(guī)范其實(shí)就是以前的 Swagger 規(guī)范，它是一種 REST API 的描述格式，通過(guò)既定的規(guī)范來(lái)描述文檔接口，它是業(yè)界真正的 API 文檔標(biāo)準(zhǔn)，可以通過(guò) YAML 或者 JSON 來(lái)描述。它包括如下內(nèi)容：
- 接口(/users)和每個(gè)接口的操作(GET /users，POST /users)
- 輸入?yún)?shù)和響應(yīng)內(nèi)容
- 認(rèn)證方法
- 一些必要的聯(lián)系信息、license 等。
關(guān)于 OpenAPI 的更多內(nèi)容，感興趣的小伙伴可以在 GitHub 上查看：https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md
依賴(lài)
以前在使用 2.9.2 這個(gè)版本的時(shí)候，一般來(lái)說(shuō)我們可能需要添加如下兩個(gè)依賴(lài)：
io.springfox springfox-swagger2 2.9.2 io.springfox springfox-swagger-ui 2.9.2
這兩個(gè)，一個(gè)用來(lái)生成接口文檔(JSON 數(shù)據(jù))，另一個(gè)用來(lái)展示將 JSON 可視化。
在 3.0 版本中，我們不需要這么麻煩了，一個(gè) starter 就可以搞定：
io.springfox springfox-boot-starter 3.0.0
和 Spring Boot 中的其他 starter 一樣，springfox-boot-starter 依賴(lài)可以實(shí)現(xiàn)零配置以及自動(dòng)配置支持。也就是說(shuō)，如果你沒(méi)有其他特殊需求，加一個(gè)這個(gè)依賴(lài)就行了，接口文檔就自動(dòng)生成了。
接口地址
3.0 中的接口地址也和之前有所不同，以前在 2.9.2 中我們主要訪問(wèn)兩個(gè)地址：
- 文檔接口地址：http://localhost:8080/v2/api-docs
- 文檔頁(yè)面地址：http://localhost:8080/swagger-ui.html
現(xiàn)在在 3.0 中，這兩個(gè)地址也發(fā)生了變化：
- 文檔接口地址：http://localhost:8080/v3/api-docs
- 文檔頁(yè)面地址：http://localhost:8080/swagger-ui/index.html
特別是文檔頁(yè)面地址，如果用了 3.0，而去訪問(wèn)之前的頁(yè)面，會(huì)報(bào) 404。
注解舊的注解還可以繼續(xù)使用，不過(guò)在 3.0 中還提供了一些其他注解。
例如我們可以使用 @EnableOpenApi 代替以前舊版本中的 @EnableSwagger2。
話是這么說(shuō)，不過(guò)松哥在實(shí)際體驗(yàn)中，感覺(jué) @EnableOpenApi 注解的功能不明顯，加不加都行。翻了下源碼，@EnableOpenApi 注解主要功能是為了導(dǎo)入 OpenApiDocumentationConfiguration 配置類(lèi)，如下：
- @Retention(value = java.lang.annotation.RetentionPolicy.RUNTIME)
- @Target(value = {java.lang.annotation.ElementType.TYPE})
- @Documented
- @Import(OpenApiDocumentationConfiguration.class)
- public @interface EnableOpenApi {
- }
然后我又看了下自動(dòng)化配置類(lèi) 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 {
- }
可以看到，自動(dòng)化配置類(lèi)里邊也導(dǎo)入了 OpenApiDocumentationConfiguration。
所以在正常情況下，實(shí)際上不需要添加 @EnableOpenApi 注解。
根據(jù) OpenApiAutoConfiguration 上的 @ConditionalOnProperty 條件注解中的定義，我們發(fā)現(xiàn)，如果在 application.properties 中設(shè)置 springfox.documentation.enabled=false，即關(guān)閉了 swagger 功能，此時(shí)自動(dòng)化配置類(lèi)就不執(zhí)行了，這個(gè)時(shí)候可以通過(guò) @EnableOpenApi 注解導(dǎo)入 OpenApiDocumentationConfiguration 配置類(lèi)。技術(shù)上來(lái)說(shuō)邏輯是這樣，不過(guò)應(yīng)用中暫未發(fā)現(xiàn)這樣的需求(即在 application.properties 中關(guān)閉 swagger，再通過(guò) @EnableOpenApi 注解開(kāi)啟)。
本文轉(zhuǎn)載自微信公眾號(hào)「 江南一點(diǎn)雨」，可以通過(guò)以下二維碼關(guān)注。轉(zhuǎn)載本文請(qǐng)聯(lián)系 江南一點(diǎn)雨公眾號(hào)。
標(biāo)題名稱(chēng)：Swagger3.0，你所不知道的新變化！
鏈接分享：http://fisionsoft.com.cn/article/dpdpdgj.html
