📄️ 定义路由
要开始构建基于 tRPC 的 API,你首先需要定义路由。一旦掌握了基础知识,你就可以了解更高级的用例。
📄️ 定义过程
过程是暴露给客户端的函数,它可以是以下之一:
📄️ 输入和输出验证器
tRPC 过程可以为其输入和/或输出定义验证逻辑,并且验证器还用于推断输入和输出的类型。我们为许多流行的验证器提供一流的支持,你可以 集成验证器 我们不直接支持。
📄️ 合并路由
将代码中的所有 API 代码写入同一个文件中并不是一个好主意。将路由与其他路由合并很容易。
📄️ 上下文
你的上下文保存所有 tRPC 过程都可以访问的数据,并且是放置数据库连接或身份验证信息等内容的好地方。
📄️ 中间件
你可以使用 t.procedure.use() 方法将中间件添加到过程中。中间件将封装过程的调用,并且必须传递其返回值。
🗃️ 使用适配器托管 tRPC
6 items
📄️ 服务器端调用
你可能需要直接从托管的同一服务器调用你的过程,可以使用 createCallerFactory() 来实现此目的。这对于服务器端调用和 tRPC 过程的集成测试非常有用。
📄️ 授权
每个传入请求都会调用 createContext 函数,因此你可以在此处从请求对象添加有关调用用户的上下文信息。
📄️ 错误处理
每当过程中发生错误时,tRPC 都会使用包含 "error" 属性的对象响应客户端。该属性包含处理客户端错误所需的所有信息。
📄️ 格式错误
路由中的错误格式将一直推断到你的客户端(和 React 组件)
📄️ 数据转换器
你可以序列化响应数据和输入参数。转换器需要添加到服务器和客户端。
📄️ 元数据
过程元数据允许你添加可选的过程特定 meta 属性,该属性将在所有 中间件 函数参数中可用。
📄️ 响应缓存
以下示例使用 Vercel 的边缘缓存 尽快向你的用户提供数据。