springboot 2.1.6.RELEASE整合Swagger2

一、引入依賴

　　 <modelVersion>4.0.0</modelVersion>
    <groupId>com.badcat</groupId>
    <artifactId>demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>
    
    <properties>
        <maven-jar-plugin.version>3.1.1</maven-jar-plugin.version>
    </properties>
    
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.6.RELEASE</version>
        <relativePath/>
    </parent>
    
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        
        <!-- swagger2 配置 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.4.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.4.0</version>
        </dependency>
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.6</version>
        </dependency>
    </dependencies>

二、創建配置類

 

package com.badcat.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 Swagger2 {

//    http://localhost:8080/swagger-ui.html     
//    http://localhost:8080/doc.html     

    // 配置swagger2核心配置 docket
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)  　　　　　　　　// 指定api類型為swagger2
                    .apiInfo(apiInfo())                 　　　　　　　　// 用於定義api文檔匯總信息
                    .select()
                    .apis(RequestHandlerSelectors
                            .basePackage("com.badcat.controller"))   // 指定controller包
                    .paths(PathSelectors.any())         　　　　　　　　// 所有controller
                    .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("后台接口api")        　　　　　　　　　　　　　　　　// 文檔頁標題
                .contact(new Contact("badcat",
                        "https://www.xxxx.com",
                        "[e-mail]"))        　　　　　　　　　　　　　// 聯系人信息
                .description("后台api文檔")  　　　　　　　　　　　　　　　　// 詳細信息
                .version("1.0.1")   　　　　　　　　　　　　　　　　　　　　// 文檔版本號
                .termsOfServiceUrl("https://www.xxxx.com") 　　　　　　// 網站地址
                .build();
    }

}

 

三、啟動項目

輸入網址，可以顯示出所有接口信息，可以直接調試。下邊是兩種風格的

　　　　http://localhost:8080/swagger-ui.html， http://localhost:8080/doc.html