SpringBoot Swagger增强版【knife4j】基础使用SpringBoot Swagger增强版【knif

SpringBoot Swagger增强版【knife4j】基础使用方式.

1.在项目pom.xml中导入依赖

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

2.在WebMvcConfig上,添加相应配置:注释和返回配置类.

@Slf4j
@Configuration
@EnableSwagger2 //使用swagger
@EnableKnife4j  //使用swagger增强
public class WebMvcConfig implements WebMvcConfigurer {

    //开始进行静态资源映射
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        /** 设置访问后台页面的路径
         * 下方这个配置的意思是,将 /backend/** 的请求映射到 resources文件下:/backend/
         * 重点:【classpath】就是resources
         * */
         // 注册swagger生成的相关文档路径
        registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
    }

    /**
     * Knife4j的配置基
     */
    @Bean
    public Docket createRestApi() {
        //指定接口扫描的包
        Predicate<RequestHandler> requestHandlerPredicate = RequestHandlerSelectors.basePackage("com.example.rejiwaimai2.main.*.controller");
        //返回文档类型
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(this.apiInfo())
                .select()
                .apis(requestHandlerPredicate)
                .paths(PathSelectors.any())
                .build();
    }
    /**
    * 接口文档的描述
    */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("吉吉跑腿")
                .version("1.0")
                .description("吉吉跑腿接口文档").build();
    }
}