Knife4j 的基本使用说明

最新推荐文章于 2025-06-21 21:53:27 发布

Melody_1943

最新推荐文章于 2025-06-21 21:53:27 发布

阅读量2k

点赞数

CC 4.0 BY-SA版权

本文链接：https://blog.csdn.net/Melody_1943/article/details/125228543

本文档详细介绍了如何在SpringBoot项目中集成Knife4j，以生成在线API文档。首先，需要在pom.xml添加依赖，然后创建Knife4jConfig配置类，配置API的基本信息如包名、分组、主机名、标题等。接着，通过@Api和@ApiOperation注解在控制器和方法上添加元数据，以生成详细的接口描述。最后，启用Knife4j的增强模式并在浏览器中访问doc.html查看生成的API文档。通过@ApiOperationSupport注解可以进一步定制接口显示顺序，而@ApiModelProperty则用于自定义参数和响应的展示。

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

Knife4j 的使用

Knife4j是一款可以提供在线API文档的框架，是基于Swagger框架实现的。

在Spring Boot项目中，使用Knife4j需要添加依赖knife4j-spring-boot-starter：

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

然后，需要添加配置，则在boot-demo项目的cn.tedu.boot.demo.config包下创建Knife4jConfig类：

代码配置

完成后启动项目，从浏览器进入localhost：8080.doc.html#/home即可进入


package cn.store.boot.demo.config;

import com.github.xiaoymin.knife4j.spring.extension.OpenApiExtensionResolver;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;

@Configuration
@EnableSwagger2WebMvc
public class Knife4jConfig {
    /**
     * 【重要】指定Controller包路径(必须修改的包名)
     */
    private String basePackage = "xx.xxxx.boot.demo.controller";
    /**
     * 分组名称
     */
    private String groupName = "product";
    /**
     * 主机名
     */
    private String host = "http://xxxx.xxxx.cn";
    /**
     * 标题
     */
    private String title = "XXX商城在线API文档--商品管理";
    /**
     * 简介
     */
    private String description = "XXX商城在线API文档--商品管理";
    /**
     * 服务条款URL
     */
    private String termsOfServiceUrl = "http://www.apache.org/licenses/LICENSE-2.0";
    /**
     * 联系人
     */
    private String contactName = "XXXXXXXXX";
    /**
     * 联系网址
     */
    private String contactUrl = "http://XXXX.XXXX.cn";
    /**
     * 联系邮箱
     */
    private String contactEmail = "XXXXX@XXXX.cn";
    /**
     * 版本号
     */
    private String version = "1.0.0";

    @Autowired
    private OpenApiExtensionResolver openApiExtensionResolver;

    @Bean
    public Docket docket() {
        String groupName = "1.0.0";
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .host(host)
                .apiInfo(apiInfo())
                .groupName(groupName)
                .select()
                .apis(RequestHandlerSelectors.basePackage(basePackage))
                .paths(PathSelectors.any())
                .build()
                .extensions(openApiExtensionResolver.buildExtensions(groupName));
        return docket;
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title(title)
                .description(description)
                .termsOfServiceUrl(termsOfServiceUrl)
                .contact(new Contact(contactName, contactUrl, contactEmail))
                .version(version)
                .build();
    }

}

注意：必须修改以上配置中的包名，保证是当前项目中控制器类所在的包！其它各项均可不修改，以上配置代码可以从Knife4j的官网找到！

最后，还需要在配置文件中开启Knife4j的增强模式：

# Knife4j配置
knife4j:
  # 是否开启增强模式
  enable: true

完成后，启动项目，在浏览器中访问 http://localhost:8080/doc.html 即可查看当前项目的API文档。

在控制器类上添加@Api注解，并配置tags属性，可以指定模块名称，例如：

@Api(tags = "管理员管理模块")
@RestController
@RequestMapping(value = "/admins", produces = "application/json; charset=utf-8")
public class AdminController {
    XXXXXXXX
}

在处理请求的方法上添加@ApiOperation注解可以配置业务名称，例如：

@ApiOperation("管理员登录") // 新增
@PostMapping("/login")
public JsonResult<AdminSimpleVO> login(@Validated AdminLoginDTO adminLoginDTO) {
    AdminSimpleVO adminSimpleVO = adminService.login(adminLoginDTO);
    return JsonResult.ok(adminSimpleVO);
}

当需要指定各业务在API文档中的显示顺序时，可以在处理请求的方法上添加@ApiOperationSupport注解，配置此注解的order属性，最终在显示API文档时，会根据order属性值升序排列，例如：

@ApiOperation("管理员登录")
@ApiOperationSupport(order = 900) // 新增
@PostMapping("/login")
public JsonResult<AdminSimpleVO> login(@Validated AdminLoginDTO adminLoginDTO) {
    AdminSimpleVO adminSimpleVO = adminService.login(adminLoginDTO);
    return JsonResult.ok(adminSimpleVO);
}

通常，建议以上配置的order值至少是2位的数字，并且有预留位置，例如10_{19之间的都是增加数据的业务，20}29之间的都是删除数据的业务，30_{39之间都是修改数据的业务，40}49之间都是查询数据的业务。

如果控制器处理请求的方法的参数是自定义的封装类型，可以在封装类型的属性上添加@ApiModelProperty来配置参数在文档中的显示，例如：

package cn.tedu.boot.demo.pojo.dto;


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

import javax.validation.constraints.NotNull;
import java.io.Serializable;

@Data
public class AdminLoginDTO implements Serializable {

    @ApiModelProperty(value = "用户名") // 配置参数名
    private String username;
    
    @ApiModelProperty("密码") // 配置参数名
    private String password;

}

以上@ApiModelProperty除了可以配置参数在API文档中显示的名称以外，还可以配置是否必须，例如：

@ApiModelProperty(value = "用户名", required = true)

另外，还可以配置参数类型等，但是，并不是必须配置，通常框架可以正常自动识别。

对于部分名称可能比较特殊（一般人直接看不懂）的属性，或者对值的规范性要求比较明确（例如某些取值为0或1）的属性，可以列举示例，使得查看API文档的人可以参考，例如：

@ApiModelProperty(value = "用户名", required = true, example = "admin")

除以配置请求参数以外，此属性还可以用于响应结果的类型，例如：

public class JsonResult implements Serializable {

@ApiModelProperty("业务状态码")
private Integer state;

@ApiModelProperty("消息")
private String message;

@ApiModelProperty("数据")
private T data;

// ......

如果以上private T data;的实际值也需要添加说明，则在对应的类的属性上继续使用@ApiModelProperty配置即可！需要注意：此处data属性可以是任意数据类型，必须声明为泛型，不可以是Object，否则将无法应用@ApiModelProperty的配置。

另外，当添加在响应的类型的属性上时，还可以在@ApiModelProperty注解中配置position属性，用于设置各属性在响应的JSON中的显示顺序，例如：

@ApiModelProperty(value = "业务状态码", position = 5)