当前位置: 首页 > 网络应用技术

再见Swagger UI!中国人开源一个超级使用的API文档框架:Star 4.7K+,真的很香!

时间:2023-03-07 00:56:30 网络应用技术

  最近,堆栈长期发现,一些国内开源项目使用了Knife4J技术,看到这个名字真是敏锐的!

  这是缩写:

  knife4j = Java的刀?

  爪哇匕首?

  看起来不错。当然,这是我的简单猜测。它无法猜测它实际上使用了什么!

  那是什么样的框架呢?

  Knife4J的前身是Swagger-Bootstrap-UI。实际上,这是一个纯粹的Swagger UI皮肤项目。应该知道Swagger UI并不容易使用,因此Swagger-Bootstrap-UI Projectit诞生了。

  Swagger-Bootstrap-UI添加了许多丰富的服务器功能,以满足许多个性化需求。它不再仅仅专注于前端UI皮肤,因此更名为:knife4j。

  knife4j这个名字希望它可以像匕首一样小,轻巧且功能强大,也希望它可以成为Swagger Interface Document Document Services的通用增强解决方案。

  Knife4J在2017年由中国程序员肖明开源。已经超过4年了。我已经看到恒星数量超过4.7k+:

  Knife4J还赢得了GVP项目标题,即Gitee最有价值的开源项目,我发现越来越多的开源项目正在使用它,Swagger UI可以将其丢弃。

  官方网站地址:

  https://doc.xiaominfo.com/knife4j/

  开源地址:

  https://gitee.com/xiaom/knife4j

  knife4j使用vue +和设计vue组件进行重写。相关界面被取出以供所有人奖励。

  接口文档显示接口:

  接口调试接口:

  Swagger模型功能:

  支持导出脱机Markdown,HTML:

  knife4j真的很强大。整个接口基于左右菜单公式的布局。它支持多个标签以同时打开显示并切换。文件和调试更清晰。感觉更符合中国人的运营习惯。

  Knife4J目前正在支持Java开发,并支持Spring MVC,Spring Boot,Spring Cloud Framework的集成使用。

  基于本文的Spring Boot,该堆栈基于Spring Boot:

  注意:使用knife4j 2.0.6+版本,弹簧启动版本要求2.2.x+

  1. knife4j依赖性介绍

  2. knife4j配置启用增强功能和基本登录身份验证:

  支持个性化配置项,例如接口地址,接口描述属性,UI增强和其他个性化配置功能:

  不会引入弹簧启动基础知识。给您发送“春季靴研究笔记”。我会第一次与您分享。

  3.将两个新的测试接口添加到新的测试接口,一个登录(帖子)和一个问题。

  为了支持接口顺序和接口作者,使用了@apioperationsupport nife4j的注释。其他的是带有招摇的注释。从该目录中,还支持以下评论:

  您可以在官方网站上了解更多信息。

  完整的演示代码不是一个。本教程的所有实际源代码已上传到此仓库:

  https://github.com/javastacks/spring-boot-best-practice

  4. knife4j测试启动应用程序,打开knife4j文档页面:

  http:// localhost:8080/doc.html

  首页将显示已配置的一些文档参数和接口统计信息,并且在“主菜单”菜单中还可以看到我们测试模块的两个接口。

  接口文档:

  调试:

  在这里,接口排序的堆栈和作者的界面功能,还支持许多功能功能,例如组排序,自定义文档,Swagger Resource Protection,Export Markdown,Camereter Cache等。

  好吧,今天我介绍了中国程序员开源的Knife4J项目,这是Swagger的增强版本。毫无疑问,它比Swagger UI更强,更好,更好!

  如果您还使用Swagger,则可以考虑使用Knife4J。它不仅具有更强的UI,而且还具有29个增强功能。它们不是替代关系,就像Mybatis Plus和Mybatis之间的关系一样,它可以帮助您提高发展的生产率。

  如果您还使用knife4j,请留言分享!

  本节中的所有实际代码源代码已上传到此仓库:

  https://github.com/javastacks/spring-boot-best-practice

  好吧,这是今天的分享。后者的堆栈负责人将分享更多有趣的Java技术和最新技术信息。请注意公共帐户Java Technology Stack以推动第一次。完成后,请在公共帐户的背景下回复关键字“访谈”。

  最后,我认为我的文章收获给您,移动我的小手,给我一点手,阅读和转发并不容易。这不简单。

   本文是原始的公共帐户“ Java Technology Stack”。