Knife4j 使用配置
从上面的内容可以看出 knife4j 的功能是很强大的,但令我更惊喜的是它的配置异常的简单,我们只需在已经成功配置了 Swagger 的项目中(Swagger 配置可参考我的上一篇文章),添加 Knife4j 的依赖即可,配置信息如下:
<!-- https://mvnrepository.com/artifact/com.github.xiaoymin/knife4j-spring-boot-starter --> <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-spring-boot-starter</artifactId> <version>3.0.2</version> </dependency>
经过以上简单的依赖添加之后,无需配置任何内容,我们就可以成功的使用 Knife4j 了。
访问 Knife4j
我们可以通过 http://localhost:8080/doc.html 访问 Knife4j 的主页,如下图所示:
总结
Swagger 作为非常欢迎的框架同时也存在着一些功能“缺陷”,那么为了弥补 Swagger 的不足,我们引入了 Knife4j 框架,使用 Knife4j 我们可以很方便的实现:接口搜索、离线文档下载、全局参数设置、接口过滤和更加友好的接口测试等功能。然而和它的功能同样令人惊讶的是它的配置,在使用 Knife4j 时,我们只需要在项目中添加它的引用,之后无需任何多余的操作就可以直接使用 Knife4j 了,简直完美,所以你不来试一试吗?