在Spring Boot中集成Swagger2

版本说明

集成说明

1. pom.xml

<properties>
    <swagger2.version>2.8.0</swagger2.version>
</properties>

<dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>${swagger2.version}</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>${swagger2.version}</version>
        </dependency>

2. Swagger 配置类

swagger需要定义一些版本，扫描的类以及文档基础信息等，所以需要在增加一个配置类

package com.jacksoft.common.configuration;

import io.swagger.annotations.ApiOperation;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
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;

/**
 * API 配置
 * 
 * @author <a href="mailto:zhoujiangzi@126.com">Jack.Zhou</a>
 * @package com.jacksoft.common.configuration
 * @version V1.0
 */
@Configuration
@EnableSwagger2
public class APISwaggerConfig extends WebMvcConfigurerAdapter{


    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/**").addResourceLocations("classpath:/META-INF/resources/").setCachePeriod(0);
    }

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any()).build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("接口文档")
                .description("更多信息请访问：https://www.jianshu.com/u/4d59a48801fc")
                .termsOfServiceUrl("https://www.jianshu.com/u/4d59a48801fc")
                .version("V1.1").build();
    }
}

这里实际上是根据注解ApiOperation进行扫描的，当然也可以扫描Api 这个注解，可以根据实际情况进行调整

注意: 当前的版本需要将swagger-ui资源映射一下。

如何使用

在对应的接口方法上增加下面的注解即可

  @ApiOperation(value = "根据用户名获取用户信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "userName",value = "用户名",required = true,dataTypeClass = String.class,paramType="form")
    })

在类上添加总体注解

@Api(tags = "用户管理接口")

启动程序后，访问下面的地址即可

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