您的位置:首页 > 科技 > 能源 > 如何在springboot项目中引入knife4j接口文档

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

2024/12/23 9:35:24 来源:https://blog.csdn.net/a486368464/article/details/139748359  浏览:    关键词:如何在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即可

版权声明:

本网仅为发布的内容提供存储空间,不对发表、转载的内容提供任何形式的保证。凡本网注明“来源:XXX网络”的作品,均转载自其它媒体,著作权归作者所有,商业转载请联系作者获得授权,非商业转载请注明出处。

我们尊重并感谢每一位作者,均已注明文章来源和作者。如因作品内容、版权或其它问题,请及时与我们联系,联系邮箱:809451989@qq.com,投稿邮箱:809451989@qq.com