配置knife4j来测试后端接口且生成接口文档

最新推荐文章于 2024-05-07 10:30:16 发布

敲到自然睡

最新推荐文章于 2024-05-07 10:30:16 发布

阅读量358

点赞数 9

文章标签： java 功能测试

本文链接：https://blog.csdn.net/2401_83803717/article/details/137169762

版权

knife4j是swagger的升级版

1、使用方式

1）、导入Maven依赖

<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>${knife4j-spring..version}</version>

2）、在config包下创建WebMvcConfiguration类并继承WebMvcConfigurationSupport类，加入knife4j相关配置

/**
     * 通过knife4j生产接口文档
     * @return
     */
    @Bean
    public Docket docket(){
        ApiInfo apiInfo = new ApiInfoBuilder()
                .title("自定义")
                .version("2.0")
                .description("自定义")
                .build();
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .groupName("自定义")
                .apiInfo(apiInfo)
                .select()
                .apis(RequestHandlerSelectors.basePackage("Controller包位置"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }

3）、设置静态资源映射，否则接口文档页面无法访问

/**
     * 通过knife4j生产接口文档
     * @return
     */
    @Bean
    public Docket docket(){
        ApiInfo apiInfo = new ApiInfoBuilder()
                .title("自定义")
                .version("2.0")
                .description("自定义")
                .build();
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .groupName("自定义")
                .apiInfo(apiInfo)
                .select()
                .apis(RequestHandlerSelectors.basePackage("前端控制器位置"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }