【接口文档工具】关于knife4j的使用

云端new守夜人

已于 2023-05-22 21:16:35 修改

阅读量468

点赞数 1

分类专栏： Web项目开发文章标签： spring boot

于 2023-05-19 17:15:10 首次发布

本文链接：https://blog.youkuaiyun.com/weixin_48916759/article/details/130770159

版权

Web项目开发专栏收录该内容

10 篇文章

订阅专栏

本文介绍了如何利用knife4j这个工具在SpringBoot项目中创建接口测试文档。首先，需要引入lombok和knife4j的依赖。接着，配置WebMvcConfiguration类，设置接口文档的生成和静态资源映射。然后，使用注解如@Api、@ApiOperation等来标记Controller和方法。最后，通过@ApiModel和@ApiModelProperty注解描述数据实体。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

一、介绍

简单一点解释：测试controller接口请求时，反向映射接口信息的工具，用于接口测试。

效果（访问地址为：项目地址 + /api.html）

二、配置

基于SpringBoot的knife4j使用

1、导入依赖

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
</dependency>

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

2、配置

创建一个config -> WebMvcConfiguration.java文件

/**
 * 配置类，注册web层相关组件
 */
@Configuration
@Slf4j
public class WebMvcConfiguration extends WebMvcConfigurationSupport {

    /**
     * 通过knife4j生成接口文档
     * @return
     */
    @Bean
    public Docket docket() {
        ApiInfo apiInfo = new ApiInfoBuilder()
                .title("接口文档")
                .version("1.0")
                .description("项目接口文档")
                .build();
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.*.controller"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }

    /**
     * 设置静态资源映射
     * @param registry
     */
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/api.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
    }
}

3、注解

注解	说明
@Api	用在类上，例如Controller，表示对类的说明
@ApiModel	用在类上，例如entity、DTO、VO
@ApiModelProperty	用在属性上，描述属性信息
@ApiOperation	用在方法上，例如Controller的方法，说明方法的用途、作用

需要在controller层添加以下注解

@Slf4j
@Api(tags = "Controller_1")


    @ApiOperation("方法一")

实体内使用注解，以登录传递的数据作为模板

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

import java.io.Serializable;

@Data
@ApiModel(description = "登录信息")
public class loginData implements Serializable {

    @ApiModelProperty("用户名")
    private String username;

    @ApiModelProperty("密码")
    private String password;

}