技術標籤：springboot工具庫spring boot

springboot整合新版swagger(springfox 3.0.0版本)

參考網址:

https://mp.weixin.qq.com/s/zxgSzME4gdvXo9FKSGaMfg

springboot整合舊版swagger的參考網址

http://www.shaoming.club/archives/springboot%E6%95%B4%E5%90%88swaggermd

https://blog.csdn.net/shaoming314/article/details/109197986

前言

之前專案中整合Swagger都是直接通過依賴springfox-swagger

、springfox-swagger-ui兩個jar包來實現的，最近發現springfox 3.0.0版本已經有了自己的SpringBoot Starter，使用起來更契合SpringBoot專案，非常方便，推薦給大家！

整合步驟

1.引入依賴

pom.xml

<!--springfox swagger官方Starter-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <
 
version>3.0.0</version>
</dependency>

2.編寫配置類

/**
 * Swagger2API文件的配置
 */
@Configuration
public class Swagger2Config {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .
 
apis(RequestHandlerSelectors.basePackage("com.macro.mall.tiny.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("SwaggerUI演示")
                .description("mall-tiny")
                .contact(new Contact("macro", null, null))
                .version("1.0")
                .build();
    }
}

說明:

apis(RequestHandlerSelectors.basePackage("com.macro.mall.tiny.controller"))這個包名一定是自己專案的controller包路徑,否則swagger不生效

其餘的選項根據實際情況設定即可

3.訪問路徑

http://localhost:8088/swagger-ui/

注意事項

訪問路徑

新版本和舊版本文件訪問路徑發生了變化，新版本為：http://localhost:8088/swagger-ui/ ，舊版本為：http://localhost:8088/swagger-ui.html

其餘參考這個踩坑文件即可

https://mp.weixin.qq.com/s?__biz=MzU1Nzg4NjgyMw==&mid=2247485908&idx=1&sn=5efac361bb58058f6d85169b5d4be8c6&scene=21#wechat_redirect