Knife4j使用教程

Knife4j使用教程

简介：Knife4j是一款基于Swagger的API文档生成和管理工具，它提供了一套美观、易用的界面来展示和管理API接口文档。Knife4j具有以下特点：

1. 集成Swagger：Knife4j基于Swagger，可以直接解析Swagger注解生成API文档，无需额外的配置和编写文档。
   
2. 界面友好：Knife4j提供了一个美观、易用的界面，可以方便地查看和测试API接口。它支持接口的分类、分组、排序等功能，使得文档的组织和浏览更加便捷。
   
3. 接口测试：Knife4j内置了接口测试功能，可以直接在文档界面上进行接口的测试和调试，无需使用其他工具。
   
4. 参数校验：Knife4j支持对接口参数进行校验，可以定义参数的类型、格式、校验规则等，提高接口的安全性和可靠性。
   
5. 兼容性：Knife4j兼容Swagger 2.0规范，可以与Spring Boot、Spring MVC等常用的Java框架无缝集成。
   

对于使用Knife4j的教程，你可以按照以下步骤进行操作：

1. 引入依赖：在你的项目中添加Knife4j的相关依赖，具体的依赖配置可以参考Knife4j的官方文档。
   
2. 配置Swagger注解：在你的API接口类和方法上添加Swagger注解，用于描述接口的信息、参数、返回值等。
   
3. 启动项目：启动你的项目，访问Knife4j的接口文档页面，默认情况下可以通过/doc.html路径访问。
   
4. 查看和测试接口：在Knife4j的文档页面上，你可以查看和测试你的API接口。可以通过分类、搜索等方式快速定位到需要的接口，点击接口可以查看详细的接口信息和示例。
   

学习knife4j之前需要掌握Swagger的知识，参考这篇文章：Swagger使用教程

在上面的文章的基础上，对依赖进行替换。

把Swagger的依赖替换为

<!--引入swagger-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>
<dependency>
    <groupId>io.swagger</groupId>
    <artifactId>swagger-annotations</artifactId>
    <version>1.5.22</version>
</dependency>
<dependency>
    <groupId>io.swagger</groupId>
    <artifactId>swagger-models</artifactId>
    <version>1.5.22</version>
</dependency>

knife4j的依赖

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

同时需要在这个配置文件中，放行这个doc.html

之后访问下面这个页面，就有了 http://localhost:8080/doc.html