Knife4j框架

Knife4j框架

Knife4j是一款基于Swagger 2的在线API文档框架。

在Spring Boot中，使用此框架时，需要：

• 添加依赖
• 在配置文件（application.properties）中开启增强模式
• 编写配置类（代码相对固定，建议CV）

关于依赖的代码：

<!-- Knife4j Spring Boot：在线API -->
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>2.0.9</version>
</dependency>

关于开启增强模式，在application.properties中添加：

# 开启Knife4j的增强模式
knife4j.enable=true

关于配置类，在项目的根包下创建config.Knife4jConfiguration，代码如下：

注意：请检查basePackage属性的值！

package cn.tedu.csmall.product.config;

import com.github.xiaoymin.knife4j.spring.extension.OpenApiExtensionResolver;
import lombok.extern.slf4j.Slf4j;
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;

/**
 * Knife4j配置类
 *
 * @author java@tedu.cn
 * @version 0.0.1
 */
@Slf4j
@Configuration
@EnableSwagger2WebMvc
public class Knife4jConfiguration {

    /**
     * 【重要】指定Controller包路径
     */
    private String basePackage = "cn.tedu.csmall.product.controller";
    /**
     * 分组名称
     */
    private String groupName = "product";
    /**
     * 主机名
     */
    private String host = "http://java.tedu.cn";
    /**
     * 标题
     */
    private String title = "酷鲨商城在线API文档--商品管理";
    /**
     * 简介
     */
    private String description = "酷鲨商城在线API文档--商品管理";
    /**
     * 服务条款URL
     */
    private String termsOfServiceUrl = "http://www.apache.org/licenses/LICENSE-2.0";
    /**
     * 联系人
     */
    private String contactName = "Java教学研发部";
    /**
     * 联系网址
     */
    private String contactUrl = "http://java.tedu.cn";
    /**
     * 联系邮箱
     */
    private String contactEmail = "java@tedu.cn";
    /**
     * 版本号
     */
    private String version = "1.0.0";

    @Autowired
    private OpenApiExtensionResolver openApiExtensionResolver;

    public Knife4jConfiguration() {
        log.debug("加载配置类：Knife4jConfiguration");
    }

    @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();
    }

}

注意：以上代码适用于Spring Boot 2.6以下（不含2.6）版本！

完成后，重启项目，打开浏览器，通过 http://localhost:9080/doc.html 即可访问Knife4j的API文档。

关于Knife4j框架，还提供了一系列的注解，便于实现API文档的显示，包括：

• @Api：添加在控制器类上，配置其tags属性，用于指定模块名称，在指定的模块名称，可以使用数字编号作为名称的前缀，则多个管理模块将按照编号顺序来显示，例如：

  • @RestController
    @RequestMapping("/albums")
    @Api(tags = "03. 相册管理模块")
    public class AlbumController {
    
        @GetMapping("/test")
        public void test() {}
    
    }
    

• @ApiOperation：添加在控制器类中处理请求的方法上，配置其value属性，用于指定业务接口名称，例如：

  • @ApiOperation("删除品牌")
    @PostMapping("/delete")
    public String delete(Long id) {
    }
    

• @ApiOperationSupport：添加在控制器类中处理请求的方法上，配置其order属性，用于指定业务接口的排序编号，最终，同一个模块中的多个业务接口将按此编号升序排列，例如：

  • @ApiOperation("删除品牌")
    @ApiOperationSupport(order = 200)
    @PostMapping("/delete")
    public String delete(Long id) {
    }
    

• @ApiModelProperty：添加在POJO类的属性上，配置其value属性，用于指定请求参数的名称（说明），配置其required属性，用于指定“是否必须提交此请求参数”（仅用于显示，不具备检查功能），配置其example属性，用于指定“示例例”，例如：

  • @Data
    public class BrandAddNewDTO implements Serializable {
    
        /**
         * 是否启用，1=启用，0=未启用
         */
        @ApiModelProperty(value = "是否启用，1=启用，0=未启用", example = "1", required = true)
        private Integer enable;
    
    }
    

• @ApiImplicitParam：添加在控制器类中处理请求的方法上，配置其name属性，指定方法的参数的变量名，配置其value属性，指定此参数的说明，配置其required属性，指定此参数“是否必须提交”，配置其dataType属性，指定此参数的数据类型，例如：

  @ApiOperation("删除品牌")
  @ApiOperationSupport(order = 200)
  @ApiImplicitParam(name = "id", value = "品牌id", required = true, dataType = "long")
  @PostMapping("/delete")
  public String delete(Long id) {
  }
  

• @ApiImplicitParams：添加在控制器类中处理请求的方法上，当有多个参数需要配置时，使用此注解，且此注解的值是@ApiImplicitParam的数组，例如：

  • @ApiOperation("删除品牌")
    @ApiOperationSupport(order = 200)
    @ApiImplicitParams({
        @ApiImplicitParam(name = "id", value = "品牌id", 
                          required = true, dataType = "long")
    })
    @PostMapping("/delete")
    public String delete(Long id) {
    }
    

• @ApiIgnore：添加在处理请求的方法的参数上，当某个参数不需要显示在API文档中，则需要在参数上添加此注解，例如HttpServletRequest、HttpSession等，例如：

  @ApiOperation("删除品牌")
  @ApiOperationSupport(order = 200)
  @ApiImplicitParam(name = "id", value = "品牌id", required = true, dataType = "long")
  @PostMapping("/delete")
  public String delete(Long id, @ApiIgnore HttpSession session) {
  }