Spring Boot 2.2.13使用Knife4j

1、pom文件

        
            com.github.xiaoymin
            knife4j-spring-boot-starter
            3.0.3
        

2、创建配置类

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;
import java.util.List;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                // 仅扫描包含@Api注解的类
                .apis(RequestHandlerSelectors.withClassAnnotation(io.swagger.annotations.Api.class))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Spring Boot API 文档")
                .description("Knife4j接口文档")
                .version("1.0")
                .build();
    }
}

3、配置文件：

knife4j:
  enable: true
  basic:
    enable: false
  swagger-ui:
    path: /doc.html
    location: classpath:/META-INF/resources/
    # 新增扫描策略配置
    scan-strategy: annotation

4、使用样例：

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.*;

@RestController
@RequestMapping("/api")
@Api(tags = "基础接口")
public class DemoController {
    @GetMapping("/hello")
    @ApiOperation("欢迎接口")
    public String sayHello() {
        return "Welcome to Spring Boot!";
    }
}

5、实体类使用样例

import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

@Data
public class UserDTO {
    @ApiModelProperty("主键")
    private Long id;
    @ApiModelProperty("姓名")
    private String name;
    @ApiModelProperty("年龄")
    private Integer age;
    @ApiModelProperty("邮箱")
    private String email;
    @ApiModelProperty("城市")
    private String city;
    @ApiModelProperty("地址")
    private String address;
}