第springboot集成Swagger的方法(讓你擁有屬于自己的api管理器)很多朋友問小編springboot項目中怎么集成Swagger呢？

swagger世界上最好的api管理工具

我們為什么要使用api管理工具？在大型的項目中，如果你有非常多的接口需要統一管理，或者需要進行接口測試，那么我們通常會在繁雜地api中找到需要進行測試或者管理的接口。當然，我們可以使用postman或者谷歌瀏覽器自帶的apiTalendapiTester。但是這些工具往往只是對單個接口進行測試管理，是我們主動去人為管理的，那么為了減輕管理測試的人力成本，swagger便應運而生。

一、swagger是什么？

我先通過官方的解釋去給各位讀者描述：Swagger的目標是為RESTAPIs定義一個標準的，與語言無關的接口，使人和計算機在看不到源碼或者看不到文檔或者不能通過網絡流量檢測的情況下能發現和理解各種服務的功能。當服務通過Swagger定義，消費者就能與遠程的服務互動通過少量的實現邏輯。類似于低級編程接口，Swagger去掉了調用服務時的很多猜測。瀏覽Swagger-Spec去了解更多關于Swagger項目的信息，包括附加的支持其他語言的庫。

相信看完你還是云里霧里，沉默帶你認真解析一下：

1.1為什么swagger開始流行

早期api高度依賴

隨著技術的不斷迭代，傳統的企業生產方式已經開始出現問題。在早先后端開發和前端開發處于一個不平衡的狀態，前后端依賴的api,往往在開發時期就溝通好了，并且前端高度依賴于后端給予的接口，并且根據后端進行開發。所以早期我們很多人崇拜后端開發工程師，之前postman很好的體現了其功能的優點。

前后端分離成為現在主流

早期的前后端在融合的項目，已經不能滿足現在的業務模式?，F在的前端技術也越看越崛起了?，F在的后臺開發的結構是j交互層，邏輯處理層，數據層。而這些，好家伙，前端崛起了！出現了vue等一些優秀的前端框架。前端結構分為了前端模板，數據注入。正因為前后端的分離，前端可以直接注入自己想要的接口返回值，而不用管后端通過api給予他支持。

前后端分離,接口需要及時協同

因為前端和后端分開開發項目，如果需求需要改變，前端需要在頁面展示更多的信息：例如：當前頁面需要username，email,phone展示。前端可以通過模擬該數據，就可以得到效果

data:{

username:'沉默著忍受'，

email:'gdysds@126.com',

phone:'110',

但是如果現在我需要展示我的興趣愛好，那么我就要加一條aihao:‘打游戲'

data:{

username:'沉默著忍受'，

email:'gdysds@126.com',

phone:'110',

aihao:'打游戲'

假設我們的接口為api/mytest/mydata前端請求后端：

const{data:res}=awaitthis.$http.post("api/mytest/mydata");//后端請求接口

if(res!=null){

this.data=res.data;//將前端data，替換為后端返回的data;

else{

this.$message.error("數據獲取失敗?。?！");

但是現在返回的數據中沒有aihao:‘打游戲'，那么這個時候前端就要去怪后端沒有提供了，后端只能又要加工作量了。搞不好還打起來，哈哈哈！在一些小的公司就沒有用swagger,而是通過git管理工具，通過文檔進行api的管理，那么在開發時只要git就可以了。但是如果項目里集成了swagger，還至于嗎。

二、swagger集成在springboot

1.1maven引入依賴

代碼如下（示例）：

SpringBoot集成Swagger=springfox，兩個jar包

Springfox-swagger2

swagger-springmvc

使用Swagger

要求：jdk1.8+否則swagger2無法運行

步驟：

1、新建一個SpringBoot-web項目

2、添加Maven依賴

在pom.xml中引入依賴：

!--/artifact/io.springfox/springfox-swagger2--

dependency

groupIdio.springfox/groupId

artifactIdspringfox-swagger2/artifactId

version2.9.2/version

/dependency

!--/artifact/io.springfox/springfox-swagger-ui--

dependency

groupIdio.springfox/groupId

artifactIdspringfox-swagger-ui/artifactId

version2.9.2/version

/dependency

2.2編寫Controller層，測試確保運行成功

代碼如下（示例）：要保證swagger有可以生成的api.

2.3在Utils工具包中引入swagger配置

要使用Swagger，我們需要編寫一個配置類-SwaggerConfig來配置Swagger

@Configuration//配置類

@EnableSwagger2//開啟Swagger2的自動配置

publicclassSwaggerConfig{

運行springboot項目，訪問本地:http://localhost:8080/swagger-ui.html

這里我們基本上是可以使用了，但是很多配置都是默認的，所以我們要進一步配置

2.4swagger的詳細配置

我自己放我的配置，拿來即用！我已經寫好注釋！

packagecom.naughty.userlogin02.util;

importorg.omg.CORBA.Environment;

importorg.springframework.context.annotation.Bean;

importorg.springframework.context.annotation.Configuration;

importorg.springframework.core.env.Profiles;

importspringfox.documentation.builders.PathSelectors;

importspringfox.documentation.builders.RequestHandlerSelectors;

importspringfox.documentation.service.ApiInfo;

importspringfox.documentation.service.Contact;

importspringfox.documentation.spi.DocumentationType;

importspringfox.documentation.spring.web.plugins.Docket;

importspringfox.documentation.swagger2.annotations.EnableSwagger2;

importjava.util.ArrayList;

@Configuration//配置類

@EnableSwagger2//開啟Swagger2的自動配置

publicclassSwaggerConfig{

@Bean

publicDocketdocket(){

//設置要顯示swagger的環境

//通過enable()接收此參數判斷是否要顯示

returnnewDocket(DocumentationType.SWAGGER_2)

.apiInfo(apiInfo())

//.enable(false)//配置是否啟用Swagger，如果是false，在瀏覽器將無法訪問

.select()//通過.select()方法，去配置掃描接口,RequestHandlerSelectors配置如何掃描接口

.apis(RequestHandlerSelectors.basePackage("com.naughty.userlogin02.controller"))

//配置你想在那個controller層生產接口文檔

.paths(PathSelectors.ant("/search/**"))

//配置如何通過path過濾,即這里只掃描請求以/kuang開頭的接口

.build();

//配置文檔信息

privateApiInfoapiInfo(){

Contactcontact=newContact("沉默這忍受","/ILOVEMYDEAR","hjj2857154359@126.com");

returnnewApiInfo(

"Cartest",//標題

"索引測試管理api",//描述

"v1.0",//版本

"/ILOVEMYDEAR",//組織鏈接

contact,//