knife4j的使用

如何使用knife4j生成接口文档

Knife4j

1. 简介

knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案,前身是swagger-bootstrap-ui,取名kni4j是希望它能像一把匕首一样小巧,轻量,并且功能强悍!

(2)核心功能

该UI增强包主要包括两大核心功能：文档说明 和 在线调试

文档说明：根据Swagger的规范说明，详细列出接口文档的说明，包括接口地址、类型、请求示例、请求参数、响应示例、响应参数、响应码等信息，使用swagger-bootstrap-ui能根据该文档说明，对该接口的使用情况一目了然。

在线调试：提供在线接口联调的强大功能，自动解析当前接口参数,同时包含表单验证，调用参数可返回接口响应内容、headers、Curl请求命令实例、响应时间、响应状态码等信息，帮助开发者在线调试，而不必通过其他测试工具测试接口是否正确,简介、强大。

个性化配置：通过个性化ui配置项，可自定义UI的相关显示信息

离线文档：根据标准规范，生成的在线markdown离线文档，开发者可以进行拷贝生成markdown接口文档，通过其他第三方markdown转换工具转换成html或pdf，这样也可以放弃swagger2markdown组件

接口排序：自1.8.5后，ui支持了接口排序功能，例如一个注册功能主要包含了多个步骤,可以根据swagger-bootstrap-ui提供的接口排序规则实现接口的排序，step化接口操作，方便其他开发者进行接口对接

(3)快速集成

在需要生成接口的工程中pom.xml文件中引入knife4j的依赖,并【删除掉原来的swagger的依赖】如下图所示：

注意,如果是高版本springboot已经去除掉了validation 还需要在工程中添加依赖，因为knife4j需要使用到他

创建Swagger配置文件，和swagger一样，把swageer的依赖替换掉就行，因为knife4j底层用的就是swagger,所有注解是通用的，在配置类上新增一个注解即可@EnableKnife4j

(4)访问

在浏览器输入地址：http://localhost/doc.html

如图所示：