springboot集成Swagger的方法(讓你擁有屬于自己的api管理器)

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

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

我們?yōu)槭裁匆褂胊pi管理工具？在大型的項(xiàng)目中，如果你有非常多的接口需要統(tǒng)一管理，或者需要進(jìn)行接口測(cè)試，那么我們通常會(huì)在繁雜地api中找到需要進(jìn)行測(cè)試或者管理的接口。當(dāng)然，我們可以使用postman或者谷歌瀏覽器自帶的apiTalendapiTester。但是這些工具往往只是對(duì)單個(gè)接口進(jìn)行測(cè)試管理，是我們主動(dòng)去人為管理的，那么為了減輕管理測(cè)試的人力成本，swagger便應(yīng)運(yùn)而生。

一、swagger是什么？

我先通過(guò)官方的解釋去給各位讀者描述：Swagger的目標(biāo)是為RESTAPIs定義一個(gè)標(biāo)準(zhǔn)的，與語(yǔ)言無(wú)關(guān)的接口，使人和計(jì)算機(jī)在看不到源碼或者看不到文檔或者不能通過(guò)網(wǎng)絡(luò)流量檢測(cè)的情況下能發(fā)現(xiàn)和理解各種服務(wù)的功能。當(dāng)服務(wù)通過(guò)Swagger定義，消費(fèi)者就能與遠(yuǎn)程的服務(wù)互動(dòng)通過(guò)少量的實(shí)現(xiàn)邏輯。類似于低級(jí)編程接口，Swagger去掉了調(diào)用服務(wù)時(shí)的很多猜測(cè)。瀏覽Swagger-Spec去了解更多關(guān)于Swagger項(xiàng)目的信息，包括附加的支持其他語(yǔ)言的庫(kù)。

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

1.1為什么swagger開(kāi)始流行

早期api高度依賴

隨著技術(shù)的不斷迭代，傳統(tǒng)的企業(yè)生產(chǎn)方式已經(jīng)開(kāi)始出現(xiàn)問(wèn)題。在早先后端開(kāi)發(fā)和前端開(kāi)發(fā)處于一個(gè)不平衡的狀態(tài)，前后端依賴的api,往往在開(kāi)發(fā)時(shí)期就溝通好了，并且前端高度依賴于后端給予的接口，并且根據(jù)后端進(jìn)行開(kāi)發(fā)。所以早期我們很多人崇拜后端開(kāi)發(fā)工程師，之前postman很好的體現(xiàn)了其功能的優(yōu)點(diǎn)。

前后端分離成為現(xiàn)在主流

早期的前后端在融合的項(xiàng)目，已經(jīng)不能滿足現(xiàn)在的業(yè)務(wù)模式?，F(xiàn)在的前端技術(shù)也越看越崛起了?，F(xiàn)在的后臺(tái)開(kāi)發(fā)的結(jié)構(gòu)是j交互層，邏輯處理層，數(shù)據(jù)層。而這些，好家伙，前端崛起了！出現(xiàn)了vue等一些優(yōu)秀的前端框架。前端結(jié)構(gòu)分為了前端模板，數(shù)據(jù)注入。正因?yàn)榍昂蠖说姆蛛x，前端可以直接注入自己想要的接口返回值，而不用管后端通過(guò)api給予他支持。

前后端分離,接口需要及時(shí)協(xié)同

因?yàn)榍岸撕秃蠖朔珠_(kāi)開(kāi)發(fā)項(xiàng)目，如果需求需要改變，前端需要在頁(yè)面展示更多的信息：例如：當(dāng)前頁(yè)面需要username，email,phone展示。前端可以通過(guò)模擬該數(shù)據(jù)，就可以得到效果

data:{

username:'沉默著忍受'，

email:'gdysds@126.com',

phone:'110',

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

data:{

username:'沉默著忍受'，

email:'gdysds@126.com',

phone:'110',

aihao:'打游戲'

假設(shè)我們的接口為api/mytest/mydata前端請(qǐng)求后端：

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

if(res!=null){

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

else{

this.$message.error("數(shù)據(jù)獲取失?。。。?);

但是現(xiàn)在返回的數(shù)據(jù)中沒(méi)有aihao:‘打游戲'，那么這個(gè)時(shí)候前端就要去怪后端沒(méi)有提供了，后端只能又要加工作量了。搞不好還打起來(lái)，哈哈哈！在一些小的公司就沒(méi)有用swagger,而是通過(guò)git管理工具，通過(guò)文檔進(jìn)行api的管理，那么在開(kāi)發(fā)時(shí)只要git就可以了。但是如果項(xiàng)目里集成了swagger，還至于嗎。

二、swagger集成在springboot

1.1maven引入依賴

代碼如下（示例）：

SpringBoot集成Swagger=springfox，兩個(gè)jar包

Springfox-swagger2

swagger-springmvc

使用Swagger

要求：jdk1.8+否則swagger2無(wú)法運(yùn)行

步驟：

1、新建一個(gè)SpringBoot-web項(xiàng)目

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編寫(xiě)Controller層，測(cè)試確保運(yùn)行成功

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

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

要使用Swagger，我們需要編寫(xiě)一個(gè)配置類-SwaggerConfig來(lái)配置Swagger

@Configuration//配置類

@EnableSwagger2//開(kāi)啟Swagger2的自動(dòng)配置

publicclassSwaggerConfig{

運(yùn)行springboot項(xiàng)目，訪問(wèn)本地:http://localhost:8080/swagger-ui.html

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

2.4swagger的詳細(xì)配置

我自己放我的配置，拿來(lái)即用！我已經(jīng)寫(xiě)好注釋！

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//開(kāi)啟Swagger2的自動(dòng)配置

publicclassSwaggerConfig{

@Bean

publicDocketdocket(){

//設(shè)置要顯示swagger的環(huán)境

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

returnnewDocket(DocumentationType.SWAGGER_2)

.apiInfo(apiInfo())

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

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

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

//配置你想在那個(gè)controller層生產(chǎn)接口文檔

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

//配置如何通過(guò)path過(guò)濾,即這里只掃描請(qǐng)求以/kuang開(kāi)頭的接口

.build();

//配置文檔信息

privateApiInfoapiInfo(){

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

returnnewApiInfo(

"Cartest",//標(biāo)題

"索引測(cè)試管理api",//描述

"v1.0",//版本

"/ILOVEMYDEAR",//組織鏈接

contact,//