快捷導(dǎo)航

SpringBoot整合Swagger接口文檔工具的流程步驟

更新時(shí)間：2023年08月18日 09:58:36 作者：Jimmy

我們?cè)陂_(kāi)發(fā)接口的時(shí)候,會(huì)將接口文檔給前端的開(kāi)發(fā)者進(jìn)行對(duì)接,我們可以通過(guò)Postman或者Yapi等接口管理工具進(jìn)行編寫(xiě)管理,實(shí)際開(kāi)發(fā)中,接口的管理確實(shí)也應(yīng)該通過(guò)專(zhuān)業(yè)的工具管理,本文,我們就來(lái)談?wù)勗趺丛赟pringBoot整合Swagger接口文檔工具

我們?cè)陂_(kāi)發(fā)接口的時(shí)候，會(huì)將接口文檔給前端的開(kāi)發(fā)者進(jìn)行對(duì)接。我們可以通過(guò) Postman或者 Yapi等接口管理工具進(jìn)行編寫(xiě)管理。實(shí)際開(kāi)發(fā)中，接口的管理確實(shí)也應(yīng)該通過(guò)專(zhuān)業(yè)的工具管理。

那么，如果只是小團(tuán)隊(duì)使用，我們是否可以在邊開(kāi)發(fā)的過(guò)程中，順便把接口文檔給寫(xiě)了呢？

當(dāng)然，本文，我們就來(lái)談?wù)勗趺丛?Spring Boot整合 Swagger接口文檔工具。

本文開(kāi)發(fā)環(huán)境：

spring boot 版本 2.1.3.RELEASE
java SDK 版本 1.8
mac m1 系統(tǒng)

本文，在筆者之前的項(xiàng)目淺聊一下Spring Security的使用方法基礎(chǔ)上開(kāi)發(fā)。

筆者嘗試了下整合 swagger3，但是因?yàn)樵软?xiàng)目版本的問(wèn)題，未能整合成功。故整合 swagger2，文檔作用都一樣，就是頁(yè)面長(zhǎng)得不一樣，可以放心使用。

添加依賴(lài)

我們?cè)?pom.xml 中添加下面的依賴(lài)：

<!-- swagger -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>swagger-bootstrap-ui</artifactId>
    <version>1.9.6</version>
</dependency>

并在配置文件中添加配置：

spring.mvc.pathmatch.matching-strategy=ANT_PATH_MATCHER

引入配置

在包 com.launch.config 中添加 SwaggerConfig.java 類(lèi)：

package com.launch.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
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;
@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.launch.controller")) // 接口所在的包
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Launch 系統(tǒng)") // 標(biāo)題
                .description("Jimmy Control System") // 描述
                .version("1.0.0") // 版本
                // 姓名，聯(lián)系 link，郵箱
                .contact(new Contact("Jimmy", "https://juejin.cn/user/1996368846261294", "reng99@outlook.com"))
                .build();
    }
}

到此，我們運(yùn)行項(xiàng)目，打開(kāi)連接 http://localhost:8080/swagger-ui/index.html ，咦， 404 耶～

處理 404

版本的問(wèn)題，使得我們無(wú)法讀取 swagger 包下面的頁(yè)面。那么，我們來(lái)重寫(xiě)。

我們?cè)?com.launch.config 中新增 WebMvcConfig.java 文件：

package com.launch.config;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/**").addResourceLocations("classpath:/static/");
        registry.addResourceHandler("swagger-ui.html")
                .addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");
        registry.addResourceHandler("doc.html")
                .addResourceLocations("classpath:/META-INF/resources/");
    }
}

重新啟動(dòng)，訪問(wèn)路徑 http://localhost:8080/doc.html ，就可以看到效果。

接口信息dashboard.png