TanStack Router 中自定义 API 路由基础路径的实践指南

在构建现代前端应用时，我们经常需要将应用部署在子路径下。TanStack Router 作为新一代路由解决方案，提供了灵活的配置选项来支持这种场景。本文将深入探讨如何在 TanStack Router 中正确配置 API 路由的基础路径。

基础路径配置的核心概念

TanStack Router 提供了三种不同类型的基础路径配置：

1. 路由基础路径：通过 createTanStackRouter 的 basepath 参数配置
2. 服务器函数基础路径：在 app.config.ts 中通过 routers.server.base 配置
3. API 路由基础路径：通过 tsr.apiBase 配置

常见误区与解决方案

许多开发者会遇到一个典型问题：当尝试为 API 路由设置自定义基础路径时，服务返回 503 错误。这是因为仅仅修改 apiBase 配置是不够的，还需要同步调整项目文件结构。

正确配置步骤

1. 修改配置文件：在 app.config.ts 中更新 tsr.apiBase 为自定义路径，例如 /path/api

2. 调整文件结构：必须将 API 路由文件移动到与配置匹配的目录下。例如：

   • 原路径：app/routes/api/users.ts
   • 新路径：app/routes/path/api/users.ts

   或者使用点号表示法：

   • 替代路径：app/routes/path.api/users.ts

与文件路由的差异

值得注意的是，API 路由的配置行为与普通文件路由有所不同：

• 文件路由：配置基础路径后，路由会自动处理前缀，无需移动文件
• API 路由：必须手动调整文件位置以匹配配置的基础路径

这种差异源于两种路由类型的不同设计理念和技术实现。API 路由需要明确的文件路径映射来确保服务端能正确响应请求。

最佳实践建议

1. 保持一致性：建议项目中的所有基础路径使用相同的前缀，便于维护
2. 文档注释：在配置文件中添加注释说明路径变更对文件结构的影响
3. 渐进式迁移：大规模路径调整时，考虑分阶段实施，避免一次性改动过大

未来发展方向

TanStack 团队正在探索更直观的 API 路由配置方案，未来版本可能会简化这一过程。开发者可以关注官方更新，以获取更优雅的解决方案。

通过理解这些配置原理和注意事项，开发者可以更灵活地在各种部署环境下使用 TanStack Router，构建出更健壮的前端应用架构。