真实的国产乱ⅩXXX66竹夫人,五月香六月婷婷激情综合,亚洲日本VA一区二区三区,亚洲精品一区二区三区麻豆

成都創(chuàng)新互聯(lián)網(wǎng)站制作重慶分公司

Swagger有什么用

本篇內(nèi)容介紹了“Swagger有什么用”的有關(guān)知識,在實(shí)際案例的操作過程中,不少人都會遇到這樣的困境,接下來就讓小編帶領(lǐng)大家學(xué)習(xí)一下如何處理這些情況吧!希望大家仔細(xì)閱讀,能夠?qū)W有所成!

我們提供的服務(wù)有:網(wǎng)站制作、成都網(wǎng)站設(shè)計(jì)、微信公眾號開發(fā)、網(wǎng)站優(yōu)化、網(wǎng)站認(rèn)證、普洱ssl等。為上千多家企事業(yè)單位解決了網(wǎng)站和推廣的問題。提供周到的售前咨詢和貼心的售后服務(wù),是有科學(xué)管理、有技術(shù)的普洱網(wǎng)站制作公司

Swagger 是什么?

Swagger 是一個用于生成、描述和調(diào)用 RESTful 接口的 Web 服務(wù)。通俗的來講,Swagger  就是將項(xiàng)目中所有(想要暴露的)接口展現(xiàn)在頁面上,并且可以進(jìn)行接口調(diào)用和測試的服務(wù)。

  • PS:Swagger 遵循了 OpenAPI 規(guī)范,OpenAPI 是 Linux 基金會的一個項(xiàng)目,試圖通過定義一種用來描述 API 格式或 API  定義的語言,來規(guī)范 RESTful 服務(wù)開發(fā)過程。

Swagger 官網(wǎng)地址:https://swagger.io/

Swagger 有什么用?

從上述 Swagger 定義我們不難看出 Swagger 有以下 3 個重要的作用:

將項(xiàng)目中所有的接口展現(xiàn)在頁面上,這樣后端程序員就不需要專門為前端使用者編寫專門的接口文檔;

當(dāng)接口更新之后,只需要修改代碼中的 Swagger 描述就可以實(shí)時(shí)生成新的接口文檔了,從而規(guī)避了接口文檔老舊不能使用的問題;

通過 Swagger 頁面,我們可以直接進(jìn)行接口調(diào)用,降低了項(xiàng)目開發(fā)階段的調(diào)試成本。

 Swagger有什么用

Swagger有什么用

Swagger 舊版本使用

Swagger 舊版本也就是目前市面上主流的 V2 版本是 Swagger 2.9.2,在講新版本之前,我們先來回顧一下  Swagger 2.9.2 是如何使用的。

Swagger 2.9.2 的使用分為以下 4 步:

  1. 鴻蒙官方戰(zhàn)略合作共建——HarmonyOS技術(shù)社區(qū)

  2. 添加依賴

  3. 開啟 Swagger 功能

  4. 配置 Swagger 文檔摘要信息

  5. 調(diào)用接口訪問

下面我們分別來看。

1.添加依賴

首先,我們要去 mvnrepository 查詢 Swagger  的依賴,搜索“springfox”關(guān)鍵字,得到結(jié)果的前兩條依賴信息,就是我們想要的結(jié)果,如下圖所示:

Swagger有什么用

將這兩個依賴添加帶項(xiàng)目中:

      io.springfox     springfox-swagger2     2.9.2         io.springfox     springfox-swagger-ui     2.9.2 
為什么是“springfox”?

問:我們要使用的是 Swagger,為什么要搜索“springfox”?

答:Swagger 可以看作是一個遵循了 OpenAPI 規(guī)范的一項(xiàng)技術(shù),而 springfox 則是這項(xiàng)技術(shù)的具體實(shí)現(xiàn)。就好比 Spring 中的  AOP 和 DI 一樣,前者是思想,而后者是實(shí)現(xiàn)。

2.開啟Swagger

在 Spring Boot 的啟動類或配置類中添加 @EnableSwagger2 注釋,開啟 Swagger,部分核心代碼如下:

@EnableSwagger2 @SpringBootApplication public class Application {...

3.配置摘要信息

import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2;  @Configuration public class SwaggerConfig {     @Bean     public Docket createRestApi() {         return new Docket(DocumentationType.SWAGGER_2) // 1.SWAGGER_2                 .select()                 .apis(RequestHandlerSelectors.basePackage("com.example.swaggerv2.controller")) // 2.設(shè)置掃描路徑                 .build();     } }

4.訪問Swagger

項(xiàng)目正常啟動之后使用“http://localhost:8080/swagger-ui.html”訪問Swagger頁面,如下圖所示:

 Swagger有什么用

Swagger 最新版使用

Swagger 最新版的配置步驟和舊版本是一樣,只是每個具體的配置項(xiàng)又略有不同,具體步驟如下。

1.添加依賴

    io.springfox   springfox-boot-starter   3.0.0 

從上述配置可以看出,Swagger 新版本的依賴項(xiàng)只有一個,而舊版本的依賴項(xiàng)有兩個,相比來說也簡潔了很多。

2.開啟Swagger

在 Spring Boot 的啟動類或配置類中添加 @EnableOpenApi 注釋,開啟 Swagger,部分核心代碼如下:

@EnableOpenApi @SpringBootApplication public class Application {...

3.配置摘要信息

import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.oas.annotations.EnableOpenApi; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket;  @Configuration public class SwaggerConfig {     @Bean     public Docket createRestApi() {         return new Docket(DocumentationType.OAS_30) // v2 不同                 .select()                 .apis(RequestHandlerSelectors.basePackage("com.example.swaggerv3.controller")) // 設(shè)置掃描路徑                 .build();     } }

從上述代碼可以看出 Docket 的配置中只有文檔的類型設(shè)置新老版本是不同的,新版本的配置是 OAS_30 而舊版本的配置是 SWAGGER_2。

  • PS:OAS 是 OpenAPI Specification 的簡稱,翻譯成中文就是 OpenAPI 說明書。

4.訪問Swagger

新版本的 Swagger 訪問地址和老版本的地址是不同的,新版版的訪問地址是“l(fā)ocalhost:8080/swagger-ui/”,如下圖所示:

Swagger有什么用

新版本 VS 老版本

新版本和老版本的區(qū)別主要體現(xiàn)在以下 4 個方面:

  1. 鴻蒙官方戰(zhàn)略合作共建——HarmonyOS技術(shù)社區(qū)

  2. 依賴項(xiàng)的添加不同:新版本只需要添加一項(xiàng),而老版本需要添加兩項(xiàng);

  3. 啟動 Swagger 的注解不同:新版本使用的是 @EnableOpenApi,而老版本是 @EnableSwagger2;

  4. Docket(文檔摘要信息)的文件類型配置不同:新版本配置的是 OAS_3,而老版本是 SWAGGER_2;

  5. Swagger UI 訪問地址不同:新版本訪問地址是“http://localhost:8080/swagger-ui/”,而老版本訪問地址是“http://localhost:8080/swagger-ui.html”。

“Swagger有什么用”的內(nèi)容就介紹到這里了,感謝大家的閱讀。如果想了解更多行業(yè)相關(guān)的知識可以關(guān)注創(chuàng)新互聯(lián)網(wǎng)站,小編將為大家輸出更多高質(zhì)量的實(shí)用文章!


當(dāng)前文章:Swagger有什么用
標(biāo)題來源:http://weahome.cn/article/gddegd.html

其他資訊

在線咨詢

微信咨詢

電話咨詢

028-86922220(工作日)

18980820575(7×24)

提交需求

返回頂部