一、基础概念
knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案,前身是swagger-bootstrap-ui,取名kni4j是希望它能像一把匕首一样小巧,轻量,并且功能强悍!
Knif4j（原名为 Swagger-Bootstrap-UI）是一款基于 Swagger 实现的文档管理工具，旨在简化接口文档的编写和管理。它提供了一套美观的界面，能够自动生成接口文档，并支持在线调试接口。Knif4j 是针对 Java 后端项目的接口文档管理工具，可以与 Spring Boot 等框架很好地集成使用。
二、Knif4j 主要具有以下特点
自动生成接口文档：根据代码中的 Swagger 注解，Knif4j 能够自动生成接口文档，包括接口信息、请求参数、响应参数等，极大地减少了编写接口文档的工作量。
可视化界面：Knif4j 提供了美观的界面，以树形结构展示接口信息，用户可以方便地浏览和查看接口文档。
在线调试接口：Knif4j 支持在线调试接口，用户可以在界面上直接输入参数并发送请求，实时查看接口的返回结果，方便进行接口测试和调试。
权限控制：Knif4j 支持对接口文档的访问权限控制，可以设置不同的用户角色和权限，保障接口文档的安全性。
5.基础特性：兼容OpenAPI 2.0和OpenAPI 3.0，提供自定义文档、动态参数调试、I18n、接口排序、导出等功能。
6.增强扩展 ：基于Springfox框架和Swagger2规范的自动注入starter，以及基于Springdoc-openapi和OAS3规范的自动注入starter。
7.框架适配：适配Spring MVC、Spring Boot 2.2至3.0、Spring WebFlux等框架。
8.社区生态：包括基于Servlet体系的微服务聚合中间件Knife4jAggregation、基于Spring Cloud Gateway网关聚合的微服务聚合中间件Knife4jDesktop。
三、使用步骤
1.导入Maven坐标，添加依赖：
<dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-spring-boot-starter</artifactId> </dependency>
2.在配置类中加入相关配置：
/**
* 通过knife4j生成接口文档
* @return
*/
@Bean
public Docket docket1() {
log.info("准备生成接口文档......");
ApiInfo apiInfo = new ApiInfoBuilder()
.title("接口文档")
.version("2.0")
.description("项目接口文档")
.build();
Docket docket = new Docket(DocumentationType.SWAGGER_2)
.groupName("管理端接口")
.apiInfo(apiInfo)
.select()
.apis(RequestHandlerSelectors.basePackage("com.sky.controller.admin"))
.paths(PathSelectors.any())
.build();
return docket;
}
3.设置静态资源，否则接口文档无法访问
/**
* 设置静态资源映射
* @param registry
*/
protected void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
}
4.接口文档访问路径：http://localhost:8080/doc.html
5.常用注解：
四、YaPi和Swagger的区别
功能对比：
Swagger 是一组用于编写基于REST的API的开源工具，它提供了生成、描述、调用和可视化RESTful风格的Web服务的规范和框架。Swagger支持自动发现和代码生成，便于后端集成，但界面设计较为简单。
YApi 是一个高效、易用、功能强大的API管理平台，它不仅提供了常用的接口管理功能，还包括权限管理、Mock数据、Swagger数据导入等功能。YApi支持导入导出，方便从Swagger迁移数据，而且支持批量接口测试和自动化测试。13
2.使用方式对比：
Swagger 可以通过Swagger UI进行在线文档的查看和测试，但目前还不支持批量接口测试。Yapi 是设计阶段使用的工具，管理和维护接口
YApi 需要导入文档，虽然也可以通过Swagger轮询导入，但与Swagger相比，YApi支持权限管理和团队协作等功能。Swagger 在开发阶段使用的框架，帮助后端开发人员做后端的接口测试
3.界面设计对比：
Swagger 的界面更像是一个接口文档，返回响应体以代码形式展示，且无法格式化。
YApi 的界面更像是一个管理系统，提供了清晰的接口管理和调试功能，如可折叠的返回数据和批量测试接口。
