如何在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即可

相关推荐

  1. SpringBoot项目整合Knife4j接口文档

    2024-06-18 07:38:06       141 阅读
  2. Springboot整合Knife4j接口文档

    2024-06-18 07:38:06       36 阅读

最近更新

  1. docker php8.1+nginx base 镜像 dockerfile 配置

    2024-06-18 07:38:06       94 阅读
  2. Could not load dynamic library ‘cudart64_100.dll‘

    2024-06-18 07:38:06       100 阅读
  3. 在Django里面运行非项目文件

    2024-06-18 07:38:06       82 阅读
  4. Python语言-面向对象

    2024-06-18 07:38:06       91 阅读

热门阅读

  1. Python模拟车站检票系统

    2024-06-18 07:38:06       30 阅读
  2. mysql json查询去除值的引号

    2024-06-18 07:38:06       31 阅读
  3. 策略模式在springboot中的使用

    2024-06-18 07:38:06       32 阅读
  4. 力扣第205题“同构字符串”

    2024-06-18 07:38:06       29 阅读
  5. 堆排序!!

    2024-06-18 07:38:06       28 阅读
  6. [python学习]-- 类

    2024-06-18 07:38:06       27 阅读
  7. C和C++

    2024-06-18 07:38:06       21 阅读
  8. 【 Python 自动化脚本:高效管理文件和文件夹】

    2024-06-18 07:38:06       27 阅读
  9. Starknet架构之Starknet state、State commitment

    2024-06-18 07:38:06       32 阅读
  10. SpringBoot3使用Swagger

    2024-06-18 07:38:06       33 阅读
  11. Mybatis 的缓存功能

    2024-06-18 07:38:06       25 阅读