springboot集成Swagger的方法(讓你擁有屬于自己的api管理器)
很多朋友問小編springboot項(xiàng)目中怎么集成Swagger呢?
swagger世界上最好的api管理工具
前言
我們?yōu)槭裁匆褂胊pi管理工具?在大型的項(xiàng)目中,如果你有非常多的接口需要統(tǒng)一管理,或者需要進(jìn)行接口測(cè)試,那么我們通常會(huì)在繁雜地api中找到需要進(jìn)行測(cè)試或者管理的接口。當(dāng)然,我們可以使用postman或者谷歌瀏覽器自帶的api Talend api Tester 。 但是這些工具往往只是對(duì)單個(gè)接口進(jìn)行測(cè)試管理,是我們主動(dòng)去人為管理的,那么為了減輕管理測(cè)試的人力成本,swagger便應(yīng)運(yùn)而生。
一、swagger是什么?
我先通過官方的解釋去給各位讀者描述: Swagger™的目標(biāo)是為REST APIs 定義一個(gè)標(biāo)準(zhǔn)的,與語言無關(guān)的接口,使人和計(jì)算機(jī)在看不到源碼或者看不到文檔或者不能通過網(wǎng)絡(luò)流量檢測(cè)的情況下能發(fā)現(xiàn)和理解各種服務(wù)的功能。當(dāng)服務(wù)通過Swagger定義,消費(fèi)者就能與遠(yuǎn)程的服務(wù)互動(dòng)通過少量的實(shí)現(xiàn)邏輯。類似于低級(jí)編程接口,Swagger去掉了調(diào)用服務(wù)時(shí)的很多猜測(cè)。 瀏覽 Swagger-Spec 去了解更多關(guān)于Swagger 項(xiàng)目的信息,包括附加的支持其他語言的庫。
相信看完你還是云里霧里,沉默帶你認(rèn)真解析一下:
1.1 為什么swagger開始流行
- 早期api高度依賴
隨著技術(shù)的不斷迭代,傳統(tǒng)的企業(yè)生產(chǎn)方式已經(jīng)開始出現(xiàn)問題。在早先后端開發(fā)和前端開發(fā)處于一個(gè)不平衡的狀態(tài),前后端依賴的api,往往在開發(fā)時(shí)期就溝通好了,并且前端高度依賴于后端給予的接口,并且根據(jù)后端進(jìn)行開發(fā)。所以早期我們很多人崇拜后端開發(fā)工程師,之前postman很好的體現(xiàn)了其功能的優(yōu)點(diǎn)。
- 前后端分離成為現(xiàn)在主流
早期的前后端在融合的項(xiàng)目,已經(jīng)不能滿足現(xiàn)在的業(yè)務(wù)模式。現(xiàn)在的前端技術(shù)也越看越崛起了?,F(xiàn)在的后臺(tái)開發(fā)的結(jié)構(gòu)是j交互層,邏輯處理層,數(shù)據(jù)層。而這些,好家伙,前端崛起了!出現(xiàn)了vue等一些優(yōu)秀的前端框架。前端結(jié)構(gòu)分為了前端模板,數(shù)據(jù)注入。正因?yàn)榍昂蠖说姆蛛x,前端可以直接注入自己想要的接口返回值,而不用管后端通過api給予他支持。
- 前后端分離,接口需要及時(shí)協(xié)同
因?yàn)榍岸撕秃蠖朔珠_開發(fā)項(xiàng)目,如果需求需要改變,前端需要在頁面展示更多的信息:例如:當(dāng)前頁面需要username,email,phone展示。前端可以通過模擬該數(shù)據(jù),就可以得到效果
data:{
username:'沉默著忍受',
email:'gdysds@126.com',
phone:'110',
}
但是如果現(xiàn)在我需要展示我的興趣愛好,那么我就要加一條aihao:‘打游戲'
data:{
username:'沉默著忍受',
email:'gdysds@126.com',
phone:'110',
aihao:'打游戲'
}
假設(shè)我們的接口為api/mytest/mydata 前端請(qǐng)求后端:
const {data :res} = await this.$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ù)中沒有 aihao:‘打游戲',那么這個(gè)時(shí)候前端就要去怪后端沒有提供了,后端只能又要加工作量了。搞不好還打起來,哈哈哈!在一些小的公司就沒有用swagger,而是通過git管理工具,通過文檔進(jìn)行api的管理,那么在開發(fā)時(shí)只要git就可以了。但是如果項(xiàng)目里集成了swagger,還至于嗎。
二、swagger集成在springboot
1.1 maven引入依賴
代碼如下(示例):
SpringBoot集成Swagger => springfox,兩個(gè)jar包
Springfox-swagger2
swagger-springmvc
使用Swagger
要求:jdk 1.8 + 否則swagger2無法運(yùn)行
步驟:
1、新建一個(gè)SpringBoot-web項(xiàng)目
2、添加Maven依賴
在pom.xml中引入依賴:
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency>
2.2 編寫Controller層,測(cè)試確保運(yùn)行成功
代碼如下(示例):要保證swagger有可以生成的api.

2.3 在Utils工具包中引入swagger配置
要使用Swagger,我們需要編寫一個(gè)配置類-SwaggerConfig來配置 Swagger
@Configuration //配置類
@EnableSwagger2// 開啟Swagger2的自動(dòng)配置
public class SwaggerConfig {
}

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

這里我們基本上是可以使用了,但是很多配置都是默認(rèn)的,所以我們要進(jìn)一步配置
2.4 swagger的詳細(xì)配置
我自己放我的配置,拿來即用!我已經(jīng)寫好注釋!
package com.naughty.userlogin02.util;
import org.omg.CORBA.Environment;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Profiles;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import java.util.ArrayList;
@Configuration //配置類
@EnableSwagger2// 開啟Swagger2的自動(dòng)配置
public class SwaggerConfig {
@Bean
public Docket docket() {
// 設(shè)置要顯示swagger的環(huán)境
// 通過 enable() 接收此參數(shù)判斷是否要顯示
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
// .enable(false) //配置是否啟用Swagger,如果是false,在瀏覽器將無法訪問
.select()// 通過.select()方法,去配置掃描接口,RequestHandlerSelectors配置如何掃描接口
.apis(RequestHandlerSelectors.basePackage("com.naughty.userlogin02.controller"))
//配置你想在那個(gè)controller層生產(chǎn)接口文檔
.paths(PathSelectors.ant("/search/**"))
// 配置如何通過path過濾,即這里只掃描請(qǐng)求以/kuang開頭的接口
.build();
}
//配置文檔信息
private ApiInfo apiInfo() {
Contact contact = new Contact("沉默這忍受", "https://blog.csdn.net/ILOVEMYDEAR", "hjj2857154359@126.com");
return new ApiInfo(
"Cartest", // 標(biāo)題
"索引測(cè)試管理api", // 描述
"v1.0", // 版本
"https://blog.csdn.net/ILOVEMYDEAR", // 組織鏈接
contact, // 聯(lián)系人信息
"Apach 2.0 許可", // 許可
"許可鏈接", // 許可連接
new ArrayList<>()// 擴(kuò)展
);
}
}
還是啟動(dòng)項(xiàng)目,并且訪問:http://localhost:8080/swagger-ui.html
接口管理演示:


這就是swagger的基本使用
總結(jié) 下一期帶你了解swagger注解的用法!關(guān)注我,教你走進(jìn)程序員的世界
到此這篇關(guān)于springboot集成Swagger的方法(讓你擁有屬于自己的api管理器)的文章就介紹到這了,更多相關(guān)springboot集成Swagger內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
透明化Sharding-JDBC數(shù)據(jù)庫字段加解密方案
這篇文章主要為大家介紹了透明化Sharding-JDBC數(shù)據(jù)庫字段加解密方案,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2022-02-02
SpringMVC+Mybatis二維碼實(shí)現(xiàn)多平臺(tái)付款(附源碼)
本文主要實(shí)現(xiàn)微信支付寶等支付平臺(tái)合多為一的二維碼支付,并且實(shí)現(xiàn)有效時(shí)間內(nèi)支付有效,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2021-08-08
深入淺析springboot中static和templates區(qū)別
這篇文章主要介紹了springboot中static和templates區(qū)別,本文通過圖文實(shí)例代碼相結(jié)合給大家介紹的非常詳細(xì),具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2020-02-02
java swing實(shí)現(xiàn)電影購(gòu)票系統(tǒng)
這篇文章主要為大家詳細(xì)介紹了java swing實(shí)現(xiàn)電影購(gòu)票系統(tǒng),文中示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2019-01-01
SpringMVC中利用@InitBinder來對(duì)頁面數(shù)據(jù)進(jìn)行解析綁定的方法
本篇文章主要介紹了SpringMVC中利用@InitBinder來對(duì)頁面數(shù)據(jù)進(jìn)行解析綁定的方法,非常具有實(shí)用價(jià)值,需要的朋友可以參考下2018-03-03
Spring?Boot項(xiàng)目中解決跨域問題的四種方式總結(jié)
這篇文章主要介紹了瀏覽器同源策略限制導(dǎo)致的跨域問題,并詳細(xì)記錄了常見的跨域解決方案,文中通過代碼介紹的非常詳細(xì),需要的朋友可以參考下2025-02-02
spring?cloud中Feign導(dǎo)入jar失敗的問題及解決方案
這篇文章主要介紹了spring?cloud中Feign導(dǎo)入jar失敗的問題及解決方案,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-03-03
java實(shí)現(xiàn)多線程的兩種方式繼承Thread類和實(shí)現(xiàn)Runnable接口的方法
下面小編就為大家?guī)硪黄猨ava實(shí)現(xiàn)多線程的兩種方式繼承Thread類和實(shí)現(xiàn)Runnable接口的方法。小編覺得挺不錯(cuò)的,現(xiàn)在就分享給大家,也給大家做個(gè)參考。一起跟隨小編過來看看吧2016-09-09
java 打印一字符串,并在main()方法內(nèi)調(diào)用它
編寫一個(gè)方法(名字自定,但要符合Java編碼規(guī)范),方法內(nèi)打印一字符串,并在main()方法內(nèi)調(diào)用它。2017-02-02

