Swagger使用

可以帮助后端生成接口文档并对接口进行测试，直接使用Swagger比较繁琐，这里使用Swagger的框架knife4j

1. 导入knife4j的坐标（maven)

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

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

@Bean//由spring框架来创建并管理对象

public Docket docket(){

        ApiInfo apiInfo =  new ApiInfoBuilder()

                .title()//文档的标题

                .version()//版本号

                .description()//对文档的描述

                .build();

        Docket docket = new Docket(DocumentationType.SWAGGER_2)

                .apiInfo(apiInfo)

                .select()

                .apis(RequestHandlerSelectors.basePackage()//要扫描的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 用在实体类上，解释该实体类的用处

@ApiModelProperty 用在实体类的属性上面，用来进一步介绍该属性的含义

@ApiOperation 用在方法上面，用来说明该方法的作用