快捷導航

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

更新時間：2021年11月18日 10:13:40 作者：沉默著忍受

在大型的項目中，如果你有非常多的接口需要統(tǒng)一管理，或者需要進行接口測試，那么我們通常會在繁雜地api中找到需要進行測試或者管理的接口,接下來通過本文給大家介紹springboot集成Swagger的方法讓你擁有屬于自己的api管理器，感興趣的朋友一起看看吧

很多朋友問小編springboot項目中怎么集成Swagger呢？

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

前言

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

一、swagger是什么？

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

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

1.1 為什么swagger開始流行

早期api高度依賴

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

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

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

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

因為前端和后端分開開發(fā)項目，如果需求需要改變，前端需要在頁面展示更多的信息：例如：當前頁面需要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 前端請求后端：

const {data :res} = await this.$http.post("api/mytest/mydata"); //后端請求接口
   if (res !=null ) {
     this.data = res.data;  //將前端data，替換為后端返回的data;
      }
   else{
     this.$message.error("數(shù)據(jù)獲取失?。。?！");
      }

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

二、swagger集成在springboot

1.1 maven引入依賴

代碼如下（示例）：
SpringBoot集成Swagger => springfox，兩個jar包
Springfox-swagger2
swagger-springmvc
使用Swagger
要求：jdk 1.8 + 否則swagger2無法運行
步驟：
1、新建一個SpringBoot-web項目
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層，測試確保運行成功

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

在這里插入圖片描述

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

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

@Configuration //配置類
@EnableSwagger2// 開啟Swagger2的自動配置
public class SwaggerConfig {  
}

在這里插入圖片描述

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

在這里插入圖片描述

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

2.4 swagger的詳細配置

我自己放我的配置，拿來即用！我已經(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的自動配置
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"))
                //配置你想在那個controller層生產(chǎn)接口文檔
                .paths(PathSelectors.ant("/search/**"))
                // 配置如何通過path過濾,即這里只掃描請求以/kuang開頭的接口
                .build();
    }

    //配置文檔信息
    private ApiInfo apiInfo() {
        Contact contact = new Contact("沉默這忍受", "https://blog.csdn.net/ILOVEMYDEAR", "hjj2857154359@126.com");
        return new ApiInfo(
                "Cartest", // 標題
                "索引測試管理api", // 描述
                "v1.0", // 版本
                "https://blog.csdn.net/ILOVEMYDEAR", // 組織鏈接
                contact, // 聯(lián)系人信息
                "Apach 2.0 許可", // 許可
                "許可鏈接", // 許可連接
                new ArrayList<>()// 擴展
        );
    }

}

還是啟動項目，并且訪問：http://localhost:8080/swagger-ui.html

在這里插入圖片描述