Spring boot-Swagger2配置与应用（简单）

一、添加两个依赖

1、添加swagger2相关功能 

<dependency>

    <groupId>io.springfox

    <artifactId>springfox-swagger2

    <version>2.9.2

</dependency>

2、 添加swagger-ui相关功能 

<dependency>

    <groupId>io.springfox

    <artifactId>springfox-swagger-ui

    <version>2.9.2

   </dependency>

二、编写配置文件

@Configuration // 告诉Spring容器，这个类是一个配置类

@EnableSwagger2 // 启用Swagger2功能

public class SwaggerConfig {

    /**

        * 配置Swagger2相关的bean

    */

    @Bean

    public DocketcreateRestApi() {

        return new Docket(DocumentationType.SWAGGER_2)

                                    .apiInfo(apiInfo()).select()

                                    .apis(RequestHandlerSelectors.basePackage("com"))// com包下所有API都交给Swagger2管理

                                    .paths(PathSelectors.any()).build();

       }

   /**

    * 此处主要是API文档页面显示信息

    */

    private ApiInfoapiInfo() {

         return new ApiInfoBuilder()

                        .title("ZhaoJun 接口")// 标题

                       .description("项目接口")// 描述

                      .termsOfServiceUrl("http://127.0.0.1")// 服务网址，一般写公司地址

                      .version("1.0")// 版本

                       .build();

          }

  }

3. 测试

启动项目后，在浏览器输入http://127.0.0.1:8080/swagger-ui.html

访问后见到以下界面：

4、遇到如下问题

Unable to infer base url. This is common when using dynamic servlet registration or when the API is behind an API Gateway. The base url is the root of where all the swagger resources are served.

解决：在启动类上添加注解@EnableSwagger2