Spring Boot 引入 Swagger2

一、添加依赖

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

 

二、配置swagger

在项目的Application目录添加swagger的配置，内容大概如下：

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;

/**
 * @ClassName: SwaggerConfig
 * @Description: 
 * @author mtyuan
 * @date 2018-1-12
 *
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {
	
	@Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.travelsky.network.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("网控相关接口API")
                .description("涉及流量查询、端口监控等接口")
                .termsOfServiceUrl("http://www.baidu.com/")
                .contact("mtyuan@travelsky.com")
                .version("1.0")
                .build();
    }

}

三、使用swagger的注解

1、controller的注解

a.类上的注解

@Api(description = "查询信息", value = "QueryDataController")

b.方法上的注解

@ApiOperation(value = "接口名称", httpMethod = "POST", response = SystemLogVO.class, notes = "接口的详细说明")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "authorization", value = "Authorization token", required = true, dataType = "String", paramType = "header") })

2、model的注解

a.类上的注解

@ApiModel(value = "SystemLogVO", description = "数据查询返回信息，包括数据数量，具体的数据信息，起止时间")

b.属性上的注解

@ApiModelProperty(value = "数据总条数", name = "total")

四、查看swagger页面

启动项目，访问如下地址，返回界面如下

 

点击可以查看接口的具体信息

 

点击 model 可以查看类的具体属性说明