Swagger入门

简介

Swagger是生成Api文档并且可以在线接口调试功能，前提是按照规范取定义接口及相关信息。

Knife4j 是为Java MVC框架集成Swagger生成Api文档的增强解决方案。

使用

1.导入 knife4j 的maven坐标

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>3.0.2</version>
</dependency>

2.在配置类中加入 knife4j 相关配置

@Bean
public Docket docket() {
    ApiInfo apiInfo = new ApiInfoBuilder()
            .title("苍穹外卖项目接口文档")
            .version("2.0")
            .description("苍穹外卖项目接口文档")
            .build();
    Docket docket = new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo)
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.sky.controller"))
            .paths(PathSelectors.any())
            .build();
    return docket;
}

3.设置静态资源映射，否则接口文档页面无法访问

protected void addResourceHandlers(ResourceHandlerRegistry registry) {
    registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");
    registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
}

4.调试

注解

@Api :用在controller类在，对类做说明。

@ApiModel: 用在entity、DTO、VO类上

@ApiModelProperty: 用在entity、DTO、VO类的属性上

@ApiOperation： 用在方法上

@Data
@ApiModel(description = "员工登录时传递的数据模型")
public class EmployeeLoginDTO implements Serializable {

    @ApiModelProperty("用户名")
    private String username;

    @ApiModelProperty("密码")
    private String password;

}