Swagger

swagger是一个用于生成服务器接口的规范性文档、并且能够对接口进行测试的工具

依赖：

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>swagger-bootstrap-ui</artifactId>
    <version>1.9.6</version>
</dependency>

 

swagger的配置

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket getDocket() {

        //创建封面信息对象
        ApiInfoBuilder apiInfoBuilder = new ApiInfoBuilder();
        apiInfoBuilder.title("后端接口说明")
                .description("此文档详细说明了后端接口规范")
                .version("1.1");
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.zht.regionbackend.controller"))
                .paths(PathSelectors.any())
                .build();
    }
}

 

controller添加注解

@Api

@ApiOperation方法注解：说明接口方法的作用

@ApiImplicitParams和@ApiImplicitParam 方法注解，说名接口方法的参数

 

访问地址：
http://localhost:8080/swagger-ui.html
http://localhost:8080/doc.html