项目生成Swagger-ui

swagger-ui默认地址

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

引入依赖

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

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

配置

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
//    配置Swagger的Docket的bean实例
    public Docket api(){
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
//        RequestHandlerSelectors配置扫描接口的方式
                .apis(RequestHandlerSelectors.any())
//                path过滤什么路径
                .paths(PathSelectors.any())
                .build();
    }
}

注解使用

@ApiOperation(value = “”, note=””)

Controller方法上使用注解

value：方法摘要在路径旁显示

note：方法详细描述

@ApiModel

类上使用注解

@ApiParam

Request（请求参数实体类）类成员变量上使用注解

  defaultValue：默认值

  required：true/false参数是否必须传

  value：参数的说明

@ApiModelProperty

VO(返回参数实体类)类成员变量上使用注解

  value：参数的说明