springboot 集成 swagger2

1 maven 導入依賴

<!-- swagger2 api  -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.6.1</version>
</dependency>

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.6.1</version>
</dependency>

2 新增配置類

package com.es.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.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class Swagger2 {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.es.controller"))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("es api")
                .description("elasticsearch restful api")
                .version("1.0")
                .build();
    }
}

3 訪問：

htthttp://localhost:8889/swagger-ui.html

4 坑 & 解決方案：

No mapping found for HTTP request with URI [/swagger-resources/configuration/ui] in DispatcherServlet with name ‘dispatcherServlet’

這個錯誤，是因爲資源映射問題導致。
我們在訪問http://127.0.0.1:8188/swagger-ui.html 時，這個swagger-ui.html相關的所有前端靜態文件都在springfox-swagger-ui-2.6.1.jar裏面。目錄如下：

Spring Boot自動配置本身不會自動把/swagger-ui.html這個路徑映射到對應的目錄META-INF/resources/下面。我們加上這個映射即可。代碼如下：

@Configuration
class WebMvcConfig extends WebMvcConfigurerAdapter {
    @Override
    void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("swagger-ui.html")
                .addResourceLocations("classpath:/META-INF/resources/")

        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/")
    }
}

同時，在啓動類上添加註解@EnableWebMvc。完整的Spring Boot集成Swagger2構建自動化Rest API文檔工程示例，源碼參考：