Skip to content

模块说明

仓库目前不是单一 Java 包,而是一组并行演进的模块。新文档站需要把这件事讲清楚,不然用户会误以为所有东西都已经在同一成熟度上。

仓库顶层模块

模块当前角色
knife4jJava 主工程,是真正对用户交付 starter 和 webjar 的地方
knife4j-doc历史 Docusaurus 文档站源码,仍保留大量旧资料
docs-site新的 VitePress 文档站原型,用来承接 knife4j-next 叙事
knife4j-front下一代前端工作区,包含解析核心、React UI、CLI 和扩展能力
knife4j-vue当前历史前端实现,更多承担“现有行为参考”角色
knife4j-vue3社区贡献的实验实现,暂不作为主线发布
knife4j-insight独立渲染/聚合方向的扩展能力

现在最应该对外强调什么

1. 交付主线还是 Java 工程

用户真正落地接入时,最关心的仍然是:

  • 引哪个 starter
  • 能不能打开 doc.html
  • 网关聚合是否正常

所以文档站首页不能被“下一代前端”抢走重心。

2. React 线是未来,不是假装现在已经完成

knife4j-front 很重要,但现在更适合被描述为:

  • 下一代 UI 和解析能力的工作区
  • 未来可能的主线前端方向
  • 先服务内部演进,再逐步对外承诺

3. 历史站点保留为资料库

短期内旧 knife4j-doc 仍有价值,因为它沉淀了大量历史文档和旧链接。新站不需要第一天就全量搬迁,只需要先接住最关键的入口页。

让 OpenAPI 文档更清晰,让接口联调更顺手。