Skip to content

迁移指引

如果你已经在使用 upstream 的 knife4j,迁移到 knife4j-next 时,建议先把目标设成“平稳切换”,而不是“顺手升级所有东西”。

最先需要知道的变化

Maven 坐标变了

最重要的变化是 groupId

旧坐标新坐标
com.github.xiaoymincom.baizhukui

这意味着你的第一步通常不是改代码,而是先改依赖来源。

推荐迁移顺序

  1. 先替换 Maven 坐标,保留你现有的业务配置和访问路径。
  2. 启动应用,确认 doc.html 能正常打开。
  3. 验证最关键的接口分组、鉴权、网关聚合和静态资源加载。
  4. 如果你还依赖旧官网文档里的某些历史功能,暂时可以把它们作为参考资料,而不是迁移阻塞点。

哪些东西尽量先别动

  • 先不要同时切换到新的前端实现。
  • 先不要把历史缓存、网关规则和上下文路径一并重构。
  • 先不要假设旧文档站里的每个链接都已经迁到新站。

这次新文档站的角色

这个 VitePress 版本不会假装自己已经把旧站所有内容都迁完。它更像是新的“主入口”:

  • 先回答“现在怎么接入”
  • 再回答“和 upstream 的差异是什么”
  • 最后再逐步承接“所有历史细节”

迁移检查清单

  • [ ] 已切换到 com.baizhukui
  • [ ] 已确认当前使用的是 Boot 2.x 还是 3.x
  • [ ] 已验证 doc.html 入口
  • [ ] 已验证常用分组和调试能力
  • [ ] 已验证网关或聚合场景
  • [ ] 已记录仍需依赖旧文档的历史功能点

关于旧文档站

你后面给域名之后,新站会进一步补:

  • 正式的迁移 FAQ
  • 旧链接跳转策略
  • 版本差异页
  • 兼容性公告页

在此之前,旧站更像“历史资料库”,新站才是你面向社区的新入口。

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