GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — GitHub - xiaoymin/knife4j: Knife4j is a set of Swagger2 and OpenAPI3 All-in-one enhancement solution

BranchesTags
Open more actions menu

Latest commit

 

History

1,930 Commits
1,930 Commits

Folders and files

NameName
Last commit message
Last commit date
.gitee
.gitee
 
 
.github/ISSUE_TEMPLATE
.github/ISSUE_TEMPLATE
 
 
backup
backup
 
 
knife4j-doc
knife4j-doc
 
 
knife4j-front
knife4j-front
 
 
knife4j-insight
knife4j-insight
 
 
knife4j-vue
knife4j-vue
 
 
knife4j-vue3
knife4j-vue3
 
 
knife4j
knife4j
 
 
static
static
 
 
.gitignore
.gitignore
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
_config.yml
_config.yml
 
 
dubbox+knife4j.md
dubbox+knife4j.md
 
 
old.md
old.md
 
 
package-lock.json
package-lock.json
 
 
swagger-annotation.md
swagger-annotation.md
 
 

Repository files navigation

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

doc.xiaominfo.com

Topics

knife4jopenapi2openapi3springdoc-openapispringfox-swagger2swaggerswagger-ui

Resources

Readme
Apache-2.0 license
Activity

Stars

4.6k stars

Watchers

74 watching

Forks

684 forks
Report repository

Releases

Packages

Contributors

Languages

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.