柳州哪里有网站建设,怎么给公司建网站,瑞安专业网站建设,做网站代刷能赚多少钱视频版内容#xff1a;Swagger 是开发中最常用的框架之一了#xff0c;但 Swagger 本身又有很多不完善的地方#xff0c;比如#xff0c;在众多的接口中查询某一个接口#xff0c;又或者是把所有的接口导出成 Word 格式等#xff0c;都无法在 Swagger 中实现。有人可能会… 视频版内容Swagger 是开发中最常用的框架之一了但 Swagger 本身又有很多不完善的地方比如在众多的接口中查询某一个接口又或者是把所有的接口导出成 Word 格式等都无法在 Swagger 中实现。有人可能会问为什么要把接口导成 Word 格式这种场景还挺常见的比如需要将接口对外部公司开放时又或者是开发环境的网络不能对外部开放如专线很多医院都拉的是专线而生产环境的 Swagger 又是关闭状态的时候这时候只能依赖离线文档来实现接口的调用了而离线文档最常用的格式便是 Word 了。那么为了解决 Swagger 的这些问题我们需要使用一个 Swagger 的增强工具来实现而这个扩展工具就是我们今天要重点介绍的 Knife4j那 Knife4j 长得是什么样呢我们一起来看如下图所示从这个主页可以看出Knife4j 会将 Swagger 中设置的摘要信息Docket显示在欢迎页Docket 的设置可以看我之前的文章并且 Knife4j 还很贴心的提供了一个统计所有接口的功能在欢迎页的最下方我们可以很清楚的看到当前 POST 接口的数量以及 GET 的接口的数量。PSKnife4j 支持中文和英文两种语言展示对于国内的小伙伴来说可读性非常的高因为都是中文的嘛。Knife4j 功能介绍1.搜索功能我觉得 Knife4j 最实用的一个功能就是“接口搜索”了通过这个功能我们可以非常方便的找到我们需要的接口如下图所示2.离线文档下载Knife4j 提供了 4 种格式的离线文档下载Markdown、Html、Word、OpenAPI 等方式如下图所示3.接口过滤可以通过 Knife4j 过滤某一类型的接口比如过滤 GET 或者 POST 接口如下图所示4.全局参数设置如果有公共的请求参数我们可以通过 Knife4j 轻松搞定如下图所示5.更友好的接口调试使用 Knife4j 可以更友好的实现接口调试因为在使用 Knife4j 时它会将必传的参数以红色边框的方式显示这样我们就直观的区分开必填参数和非必填参数了如下图所示Knife4j 使用配置从上面的内容可以看出 knife4j 的功能是很强大的但令我更惊喜的是它的配置异常的简单我们只需在已经成功配置了 Swagger 的项目中Swagger 配置可参考我的上一篇文章添加 Knife4j 的依赖即可配置信息如下!-- https://mvnrepository.com/artifact/com.github.xiaoymin/knife4j-spring-boot-starter --
dependencygroupIdcom.github.xiaoymin/groupIdartifactIdknife4j-spring-boot-starter/artifactIdversion3.0.2/version
/dependency
经过以上简单的依赖添加之后无需配置任何内容我们就可以成功的使用 Knife4j 了。访问 Knife4j我们可以通过 http://localhost:8080/doc.html 访问 Knife4j 的主页如下图所示总结Swagger 作为非常欢迎的框架同时也存在着一些功能“缺陷”那么为了弥补 Swagger 的不足我们引入了 Knife4j 框架使用 Knife4j 我们可以很方便的实现接口搜索、离线文档下载、全局参数设置、接口过滤和更加友好的接口测试等功能。然而和它的功能同样令人惊讶的是它的配置在使用 Knife4j 时我们只需要在项目中添加它的引用之后无需任何多余的操作就可以直接使用 Knife4j 了简直完美所以你不来试一试吗
