springboot集成Swagger2以及Swagger2的配置详解

Swagger2

走出六亲不认的步伐。

springboot集成Swagger2

添加依赖

springboot项目中，引入swagger2：在pom.xml中，增加如下依赖

<properties>
       <swagger.version>2.9.2</swagger.version>
       <swagger.m.version>1.0.6</swagger.m.version>
</properties>

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

<dependency>
	<groupId>com.github.xiaoymin</groupId>
	<artifactId>swagger-bootstrap-ui</artifactId>
	<version>1.9.1</version>
</dependency>
<dependency>
	<groupId>com.zyplayer</groupId>
	<artifactId>swagger-mg-ui</artifactId>
	<version>${swagger.m.version}</version>
</dependency>

Swagger2配置

创建Docket的Bean

@Component
@Configuration
@EnableSwagger2
public class SwaggerConfig  {

    @Bean
    public Docket api(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(getApiInfo())
                .select()       .apis(RequestHandlerSelectors.basePackage("com.xx.xx.xx")).paths(PathSelectors.any())
                .build();
    }

    private ApiInfo getApiInfo(){
        return new ApiInfoBuilder()
                .title("大标题")
                .description("小标题")
                .version("1.0")
                .license("Apache 2.0")
                .licenseUrl("http://www.apache.org/licenses/LICENSE-2.0")
                .build();
    }
}

通过@EnableSwagger2注解配置Swagger2可用，com.xx.xx.xx是要扫描的接口的路径。
启动项目后输入http://localhost:8080/swagger-ui.html即可进入接口首页。

Swagger2的配置详解

通过Api标签在控制器上增加描述和标签信息（非必须）

@Api(tags = “控制器标签”, description = “控制器描述”)

方法描述（非必填）

@ApiOperation: 可设置对接口的描述。
@ApiIgnore: Swagger 文档不会显示拥有该注解的接口。
@ApiImplicitParams: 用于描述接口的非对象参数集。（对象参数集无需此标签）
@ApiImplicitParam: 用于描述接口的非对象参数，与 ApiImplicitParams 组合使用。
实体描述，我们可以通过 @ApiModel 和 @ApiModelProperty 注解来对我们 API 中所涉及到的对象做描述

参考文档：
https://blog.csdn.net/zhongzk69/article/details/94987568