进阶 trpc.io 2026-10-12 05:42:24 · 40 阅读
第1章 AWS Lambda 与 API Gateway 适配器
版本:10.x AWS Lambda + API Gateway Adapter
AWS Lambda adapter
AWS Lambda adapter 支持 API Gateway REST API(v1) 和 HTTP API(v2) 两种场景。
示例应用
描述链接API Gateway 搭配 NodeJS 客户端。Source
如何接入 tRPC
1. 安装依赖
bashyarn add @trpc/server
bashyarn add @trpc/server
2. 创建 tRPC router
实现你的 tRPC router,示例如下:
server.tstsimport { initTRPC } from '@trpc/server';import { z } from 'zod';export const t = initTRPC.create();const appRouter = t.router({ getUser: t.procedure.input(z.string()).query((opts) => { opts.input; // string return { id: opts.input, name: 'Bilbo' }; }),});// 导出 API 的类型定义export type AppRouter = typeof appRouter;
server.tstsimport { initTRPC } from '@trpc/server';import { z } from 'zod';export const t = initTRPC.create();const appRouter = t.router({ getUser: t.procedure.input(z.string()).query((opts) => { opts.input; // string return { id: opts.input, name: 'Bilbo' }; }),});// 导出 API 的类型定义export type AppRouter = typeof appRouter;
3. 使用 Amazon API Gateway adapter
tRPC 内置了 API Gateway adapter,可以通过 API Gateway handler 来运行你的路由。
server.tstsimport { CreateAWSLambdaContextOptions, awsLambdaRequestHandler } from '@trpc/server/adapters/aws-lambda';const appRouter = /* ... */;// 每次请求都会调用const createContext = ({ event, context,}: CreateAWSLambdaContextOptions) => ({}) // 无上下文type Context = Awaited>;export const handler = awsLambdaRequestHandler({ router: appRouter, createContext,})
server.tstsimport { CreateAWSLambdaContextOptions, awsLambdaRequestHandler } from '@trpc/server/adapters/aws-lambda';const appRouter = /* ... */;// 每次请求都会调用const createContext = ({ event, context,}: CreateAWSLambdaContextOptions) => ({}) // 无上下文type Context = Awaited>;export const handler = awsLambdaRequestHandler({ router: appRouter, createContext,})
构建并部署代码后,就可以用 API Gateway 的 URL 来调用你的函数了。
EndpointHTTP URIgetUserGET https:///getUser?input=INPUT
这里 `INPUT` 是一个经过 URI 编码的 JSON 字符串。 关于 Payload 格式版本 当 API Gateway 调用 Lambda 时,其事件数据有两种不同的格式。对于 REST API,数据格式应为版本 "1.0"(`APIGatewayProxyEvent`);而对于 HTTP API,你可以选择版本 "1.0" 或 "2.0"。 版本 1.0:`APIGatewayProxyEvent` 版本 2.0:`APIGatewayProxyEventV2` 为了判断你使用的是哪个版本,在创建上下文时传入对应类型的参数: tsfunction createContext({ event, context,}: CreateAWSLambdaContextOptions) { ...}// CreateAWSLambdaContextOptions or CreateAWSLambdaContextOptions
tsfunction createContext({ event, context,}: CreateAWSLambdaContextOptions) { ...}// CreateAWSLambdaContextOptions or CreateAWSLambdaContextOptions
关于 Payload 格式版本的更多详情,请参见此处。
这里 `INPUT` 是一个经过 URI 编码的 JSON 字符串。 关于 Payload 格式版本 当 API Gateway 调用 Lambda 时,其事件数据有两种不同的格式。对于 REST API,数据格式应为版本 "1.0"(`APIGatewayProxyEvent`);而对于 HTTP API,你可以选择版本 "1.0" 或 "2.0"。 版本 1.0:`APIGatewayProxyEvent` 版本 2.0:`APIGatewayProxyEventV2` 为了判断你使用的是哪个版本,在创建上下文时传入对应类型的参数: tsfunction createContext({ event, context,}: CreateAWSLambdaContextOptions