{"id":31977709,"url":"https://github.com/caofancpu/knife4j","last_synced_at":"2025-10-25T00:07:08.174Z","repository":{"id":37113842,"uuid":"224087324","full_name":"caofanCPU/knife4j","owner":"caofanCPU","description":"swagger-bootstrap-ui优化版，参见原作者","archived":false,"fork":false,"pushed_at":"2022-12-15T23:26:22.000Z","size":6753,"stargazers_count":143,"open_issues_count":39,"forks_count":39,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-10-14T21:49:47.119Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://doc.xiaominfo.com/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/caofanCPU.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-11-26T02:44:55.000Z","updated_at":"2025-07-03T06:27:18.000Z","dependencies_parsed_at":"2022-08-10T08:50:14.802Z","dependency_job_id":null,"html_url":"https://github.com/caofanCPU/knife4j","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/caofanCPU/knife4j","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caofanCPU%2Fknife4j","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caofanCPU%2Fknife4j/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caofanCPU%2Fknife4j/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caofanCPU%2Fknife4j/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/caofanCPU","download_url":"https://codeload.github.com/caofanCPU/knife4j/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caofanCPU%2Fknife4j/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":280783783,"owners_count":26390274,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-24T02:00:06.418Z","response_time":73,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-10-14T21:49:04.410Z","updated_at":"2025-10-25T00:07:08.168Z","avatar_url":"https://github.com/caofanCPU.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案,前身是swagger-bootstrap-ui,取名kni4j是希望她能像一把匕首一样小巧,轻量,并且功能强悍!\n\nknife4j的前身是`swagger-bootstrap-ui`，为了契合微服务的架构发展,由于原来`swagger-bootstrap-ui`采用的是后端Java代码+前端Ui混合打包的方式,在微服务架构下显的很臃肿,因此项目正式更名为`knife4j`\n\n更名后主要专注的方面\n\n- 前后端Java代码以及前端Ui模块进行分离,在微服务架构下使用更加灵活\n- 提供专注于Swagger的增强解决方案,不同于只是改善增强前端Ui部分\n\n**效果：**[http://swagger-bootstrap-ui.xiaominfo.com/doc.html](http://swagger-bootstrap-ui.xiaominfo.com/doc.html)\n\n**示例:**[https://gitee.com/xiaoym/swagger-bootstrap-ui-demo](https://gitee.com/xiaoym/swagger-bootstrap-ui-demo)\n\n**交流：**[![](https://img.shields.io/badge/加入QQ1群-608374991(满)-red.svg)](//shang.qq.com/wpa/qunwpa?idkey=16b81902c23fbca82780fa107da1b6612e2ee44a05c4103c9176ad9d61c2f6bf)  [![](https://img.shields.io/badge/加入QQ2群-621154782-red.svg)](//shang.qq.com/wpa/qunwpa?idkey=11e0a1453a6a3695bd8ed709fbc8359c9c48dd8538aaafbece7b84ecd325b91c)\n\n\n**文档**:[https://doc.xiaominfo.com/](https://doc.xiaominfo.com/)\n\n**源码分析**:[https://www.xiaominfo.com/2019/05/20/springfox-0/](https://www.xiaominfo.com/2019/05/20/springfox-0/)\n\n## 项目模块\n\n目前主要的模块包括：\n\n| 模块名称             | 说明                                                         |\n| -------------------- | ------------------------------------------------------------ |\n| knife4j              | 为Java MVC框架集成Swagger的增强解决方案                      |\n| knife4j-admin        | 云端Swagger接口文档注册管理中心,集成gateway网关对任意微服务文档进行组合集成 |\n| knife4j-extension    | chrome浏览器的增强swagger接口文档ui,快速渲染swagger资源      |\n| knife4j-service      | 为swagger服务的一系列接口服务程序                            |\n| knife4j-front        | knife4j-spring-ui的纯前端静态版本,用于集成非Java语言使用     |\n| swagger-bootstrap-ui | knife4j的前身,最后发布版本是1.9.6                            |\n\n\n\n## 业务场景\n\n### 不使用增强功能,纯粹换一个swagger的前端皮肤\n\n不使用增强功能,纯粹换一个swagger的前端皮肤，这种情况是最简单的,你项目结构下无需变更\n\n可以直接引用swagger-bootstrap-ui的最后一个版本1.9.6或者使用knife4j-spring-ui\n\n老版本引用\n\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.github.xiaoymin\u003c/groupId\u003e\n    \u003cartifactId\u003eswagger-bootstrap-ui\u003c/artifactId\u003e\n    \u003cversion\u003e1.9.6\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n新版本引用\n\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.github.xiaoymin\u003c/groupId\u003e\n    \u003cartifactId\u003eknife4j-spring-ui\u003c/artifactId\u003e\n    \u003cversion\u003e${lastVersion}\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n### Spring Boot项目单体架构使用增强功能\n\n在Spring Boot单体架构下,knife4j提供了starter供开发者快速使用\n\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.github.xiaoymin\u003c/groupId\u003e\n    \u003cartifactId\u003eknife4j-spring-boot-starter\u003c/artifactId\u003e\n    \u003cversion\u003e${knife4j.version}\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n该包会引用所有的knife4j提供的资源，包括前端Ui的jar包\n\n### Spring Cloud微服务架构\n\n在Spring Cloud的微服务架构下,每个微服务其实并不需要引入前端的Ui资源,因此在每个微服务的Spring Boot项目下,引入knife4j提供的微服务starter\n\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.github.xiaoymin\u003c/groupId\u003e\n    \u003cartifactId\u003eknife4j-micro-spring-boot-starter\u003c/artifactId\u003e\n    \u003cversion\u003e${knife4j.version}\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n在网关聚合文档服务下,可以再把前端的ui资源引入\n\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.github.xiaoymin\u003c/groupId\u003e\n    \u003cartifactId\u003eknife4j-spring-boot-starter\u003c/artifactId\u003e\n    \u003cversion\u003e${knife4j.version}\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n## 另外说明\n\n不管是knife4j还是swagger-bootstrap-ui\n\n对外提供的地址依然是doc.html\n\n访问：http://ip:port/doc.html\n\n即可查看文档\n\n**这是永远不会改变的**\n\n\n\n## 提ISSUES必看\n\n虽然建立了QQ交流群,但是很多没用加群的朋友会通过ISSUES来反馈问题,提ISSUES本身是一个很好的技术习惯，这有助于帮助我能很好的定位问题所在,但因为我并不是实时关注,所以经常在我处理issues的时候，看到很多朋友提的问题却也无从着手，写下一些建议,希望提ISSUES的朋友能在提的时候都有涉及到：\n\n1、swagger-bootstrap-ui和springfox-swagger的版本号,这个尤为重要,很多低版本出现的问题有可能我在新发布的版本中已经解决了,每个版本都有更新日志,可以参考这篇文档：https://doc.xiaominfo.com/changelog/\n\n2、提ISSUES时贴图、贴代码,代码不用贴逻辑，只需要贴接口层即可,还有相关的实体类(如果有涉及的话)，这些信息有助于我快速定位问题,省去了来回沟通的成本,提高大家的效率\n\n3、在QQ交流群沟通的朋友我也希望能通过提ISSUE来记录下我们沟通的过程,我并非实时处理此问题，这让我集中再处理issues的时候有助于拉回我们彼此沟通时的场景，最终在新版本解决问题\n\n4、swagger-bootstrap-ui使用的是传统的JS技术,jQuery+Dom操作,打包后的源码也并没有压缩处理,代码注释部分我也有说明,应该是能理解的，如果我没有及时处理碰到的问题,欢迎大家提交pr，毕竟众人拾柴火焰高嘛\n\n## 项目Demo示例\n\nDemo示例见另外项目地址：[https://gitee.com/xiaoym/swagger-bootstrap-ui-demo](https://gitee.com/xiaoym/swagger-bootstrap-ui-demo)\n\n| 模块                            | 说明                                                         |\n| ------------------------------- | ------------------------------------------------------------ |\n| knife4j-spring-boot-demo        | 在Spring Boot架构下集成knife4j的项目示例                     |\n| knife4j-spring-boot-single-demo | 在Spring Boot单体架构下集成knife4j的项目示例                 |\n| knife4j-spring-cloud-gateway    | 在Spring Cloud微服务架构下通过gateway网集成knife4j的示例     |\n| swagger-bootstrap-ui-demo-mvc   | 在Spring MVC模式下集成swagger-bootstrap-ui                   |\n| swagger-bootstrap-ui-demo       | 在Spring Boot单体架构下集成swagger-bootstrap-ui              |\n| swagger-bootstrap-ui-gateway    | 在Spring Cloud微服务架构下通过gateway网关集成swagger-bootstrap-ui |\n| swagger-bootstrap-ui-zuul       | 在Spring Cloud微服务架构下通过zuul网关集成swagger-bootstrap-ui |\n\n## 界面效果\n\n![接口说明](static/des.png)\n\n![接口调试](static/debug.png)\n\n![个性化设置](static/settings.png)\n\n![接口离线文档](static/markdown.png)\n\n![SwaggerModels](static/models.png)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcaofancpu%2Fknife4j","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcaofancpu%2Fknife4j","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcaofancpu%2Fknife4j/lists"}