跳至主要内容
版本:10.x

轻松构建端到端类型安全的 API

codecov weekly downloads GitHub License GitHub Stars

简介

tRPC 允许您轻松构建和使用完全类型安全的 API,无需模式或代码生成。

随着 TypeScript 和静态类型在 Web 开发中越来越成为最佳实践,API 合同成为了一个主要痛点。我们需要更好的方法来 **静态类型化** 我们的 API 端点,并在我们的客户端和服务器(或服务器到服务器)之间 **共享这些类型**。我们着手构建一个简单的库来构建类型安全的 API,它利用了现代 TypeScript 的全部功能。

传统 REST 或 GraphQL 的替代方案

目前,GraphQL 是在 TypeScript 中实现类型安全 API 的主要方式(它很棒!)。由于 GraphQL 被设计为用于实现 API 的语言无关规范,因此它没有充分利用 TypeScript 等语言的功能。

如果您的项目使用全栈 TypeScript 构建,您可以 **直接** 在客户端和服务器之间共享类型,而无需依赖代码生成。

谁适合使用 tRPC?

tRPC 适用于全栈 TypeScript 开发人员。它使编写您可以在应用程序的前端和后端安全使用的端点变得容易。您的 API 合同的类型错误将在构建时被捕获,从而减少了应用程序在运行时出现错误的可能性。

功能

  •  经过良好测试,可用于生产环境。
  • 🧙‍♂️ 客户端上的完全静态类型安全和自动完成,用于输入、输出和错误。
  • 🐎 快速的开发体验 - 无需代码生成、运行时膨胀或构建管道。
  • 🍃 轻量级 - tRPC 没有依赖项,并且客户端占用空间很小。
  • 🐻 适用于新项目和旧项目 - 轻松开始使用或添加到您现有的遗留项目中。
  • 🔋 框架无关 - tRPC 社区为所有最流行的框架构建了 适配器
  • 🥃 订阅支持 - 为您的应用程序添加类型安全的可观察性。
  • ⚡️ 请求批处理 - 同时发出的请求可以自动合并为一个。
  • 👀 示例 - 查看 示例 以学习或用作起点。