跳至主内容
版本:11.x
非官方测试版翻译

本页面由 PageTurner AI 翻译(测试版)。未经项目官方认可。 发现错误? 报告问题 →

End-to-end typesafe APIs made easy

weekly downloads GitHub License GitHub Stars

简介

tRPC 让您无需模式或代码生成即可构建和使用完全类型安全的 API。它结合了 RESTGraphQL 的理念——若您对这两者不熟悉,请参阅核心概念

在 TypeScript 全栈项目中,保持客户端与服务端 API 契约同步是常见痛点。tRPC 通过直接利用 TypeScript 的类型推断能力,无需代码生成步骤,即可在构建时捕获问题。

tRPC 既可独立运行,也可通过我们丰富的适配器生态系统挂载为现有 REST API 的端点。

特性

  • ✅  经过充分测试,生产环境可用。

  • 🧙‍♂️  客户端全面的静态类型安全与自动补全,涵盖输入、输出及错误

  • 🐎  极速开发体验 - 无需代码生成、运行时臃肿或构建流程。

  • 🍃  轻量 - tRPC 零运行时依赖,客户端占用极小。

  • 🐻  新旧项目皆宜 - 易于新项目启动或添加到现有遗留项目

  • 🔋  框架无关 - tRPC 社区已为所有主流框架构建了适配器

  • 🥃  订阅支持 - 为应用添加类型安全的实时更新功能。

  • ⚡️  请求批处理 - 同时发起的请求可自动合并

  • 👀  示例 - 查看示例应用作为学习起点

快速概览

更多内容请查看视频与社区资源页面。

立即体验

或使用示例应用在本地启动项目。

集成方案

创建新项目

由于 tRPC 可集成于多种框架中,你首先需要确定使用场景。

后端提供适用于多种框架及原生 Node.js 的适配器。前端可使用我们的 TanStack React QueryNext.js 集成、适用于其他框架的第三方集成,或可在任意 JavaScript 环境运行的原生客户端

选定技术栈后,可通过 模板 搭建应用,或根据所选后端/前端集成的文档从零开始。

将 tRPC 添加到现有项目

将 tRPC 添加到现有项目与创建新项目差异不大,因此适用相同资源。主要挑战在于如何将其与现有应用集成:

  • 无需立即迁移所有后端逻辑。常见策略是初期仅在新接口使用 tRPC,后续再逐步迁移既有接口。

  • 如果您不确定从何入手,请查阅后端适配器和前端实现的文档,以及示例应用

  • 若想了解 tRPC 在大型代码库中的应用案例,可参考使用 tRPC 的开源项目

社区

加入我们的 Discord 社区,提问并分享经验!