10.Swagger的使用

步骤1：加入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>

步骤2：创建swagger配置类

@Configuration //配置类
@EnableSwagger2// 开启Swagger2的自动配置
public class SwaggerConfig {  
}

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

步骤3：通过配置Docket实例来配置Swaggger

@Bean //配置docket以配置Swagger具体参数
public Docket createRestApi() {
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo()) //关联apiInfo
        .select() //通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
        .apis(RequestHandlerSelectors.basePackage("com.jjl.swagger"))
        .paths(PathSelectors.any()) //任何请求都扫描
        .build();
}

//通过apiInfo()属性配置文档信息
private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
        .title("Spring Boot中使用Swagger2构建RESTful APIs") //标题
        .description("更多Spring Boot相关文章请关注：http://blog.didispace.com/") //描述
        .termsOfServiceUrl("http://blog.didispace.com/") //组织链接
        .contact("程序猿DD") //联系人信息
        .version("1.0") //版本
        .build();
}

步骤4：创建实体类

@ApiModel("用户实体")
public class User {
    @ApiModelProperty("用户名")
    public String username;
    @ApiModelProperty("密码")
    public String password;
}

步骤5：创建Controller

@Controller
public class UserController {
    @GetMapping("/getUser")
    public User getUser(){
        return new User();
    }
}

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

        注意： 并不是因为@ApiModel这个注解让实体显示在这里了，而是只要出现在接口方法的返回值上的实体都会显示在这里，而@ApiModel和@ApiModelProperty这两个注解只是为实体添加注释的。

常用注解