如何在springboot项目中引入knife4j接口文档

本文主要是介绍如何在springboot项目中引入knife4j接口文档，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

开发框架，帮助后端开发人员做后端接口测试

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

引入依赖

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

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

@Bean
public Docket docket() {ApiInfo apiInfo = new ApiInfoBuilder().title("xxx项目接口文档").version("2.0").description("xxx项目接口文档").build();Docket docket = new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo).select()//指定生成接口需扫描的包.apis(RequestHandlerSelectors.basePackage("com.ting.controller")).paths(PathSelectors.any()).build();return docket;
}

设置静态资源映射，否则接口文档页面无法显示 

否则会把doc.html当作一个controller，但是实际上没有这个controller就会报错404

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

 在对应controller的类上和方法上加上注解

启动项目后访问 http://localhost:8080/doc.html即可

这篇关于如何在springboot项目中引入knife4j接口文档的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！

---