xiaoymin / knife4j

Knife4j is a set of Swagger2 and OpenAPI3 All-in-one enhancement solution

Home Page:https://doc.xiaominfo.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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

knife4j的前身是swagger-bootstrap-ui,为了契合微服务的架构发展,由于原来swagger-bootstrap-ui采用的是后端Java代码+前端Ui混合打包的方式,在微服务架构下显的很臃肿,因此项目正式更名为knife4j

更名后主要专注的方面

  • 前后端Java代码以及前端Ui模块进行分离,在微服务架构下使用更加灵活
  • 提供专注于Swagger的增强解决方案,不同于只是改善增强前端Ui部分
  • 提供更多灵活的中间件方案\工具

项目模块

目前仓库主要的模块说明:

模块名称 说明
knife4j 为Java MVC框架集成Swagger的增强解决方案,Java生态下的中间件封装
knife4j-insight 开箱即用的独立解决方案,提供官方Docker镜像,基于Spring Boot 3.0编写,查看使用文档
knife4j-doc knife4j官方文档,基于Docusaurus编写,参与贡献请参考文档
knife4j-vue 当前Knife4j的前端源码,基于Vue2.0编写
knife4j-vue3 当前Knife4j的前端源码,基于Vue3.0编写,该代码库来自贡献者,目前尚未投入使用
knife4j-front knife4j的前端架构代码,目前是规划阶段,该模块尚未编码,有想法的可以通过交流群与作者沟通

获取帮助

官网文档: https://doc.xiaominfo.com/

预览地址: https://doc.xiaominfo.com/demo/doc.html

Demo示例: https://gitee.com/xiaoym/swagger-bootstrap-ui-demo

Demo说明: https://doc.xiaominfo.com/docs/action/action-simple

作者交流: 关注公众号"Knife4j",点击菜单“交流群”获取加群二维码

输入图片说明

特别声明

不管是knife4j还是swagger-bootstrap-ui

对外提供的地址依然是doc.html

访问:http://ip:port/doc.html

即可查看文档

这是永远不会改变的

界面效果

接口说明

接口调试

🤝 特别鸣谢

  • 感谢 JetBrains 提供的免费开源 License:

💪 Contributors 💪

Our contributors have made this project possible. Thank you! 🙏

Made with contrib.rocks.

Star History Chart

About

Knife4j is a set of Swagger2 and OpenAPI3 All-in-one enhancement solution

https://doc.xiaominfo.com

License:Apache License 2.0


Languages

Language:HTML 90.5%Language:JavaScript 3.6%Language:Java 2.6%Language:Vue 1.8%Language:TypeScript 0.6%Language:CSS 0.5%Language:MDX 0.4%Language:Less 0.1%Language:Shell 0.0%Language:Dockerfile 0.0%Language:Batchfile 0.0%