Fetch / Edge ランタイムアダプター
このページは PageTurner AI で翻訳されました(ベータ版)。プロジェクト公式の承認はありません。 エラーを見つけましたか? 問題を報告 →
tRPCサーバーは、WinterCG仕様(特にMinimum Common Web Platform API)に準拠するエッジランタイム環境で作成できます。
これらのランタイムには以下が含まれますが、これらに限定されません:
Cloudflare Workers
Deno Deploy
- Vercel Edge Runtime(& Next.js Edge Runtime)
これにより、WebプラットフォームAPIを使用してリクエストとレスポンスを表現するフレームワークへの統合も容易になります。例えば:
- Astro(SSRモード)
Remix
SolidStart
サンプルアプリケーション
| Description | Links |
|---|---|
| Cloudflare Workers example | Source |
| Deno Deploy example | Source |
| Next.js Edge Runtime example | Source |
| Vercel Edge Runtime example | Source |
エッジランタイムでtRPCサーバーを使用する方法
tRPCは、ネイティブのRequestとResponse APIを入力出力として使用するfetchアダプターを提供します。tRPC固有のコードはすべてのランタイムで共通であり、レスポンスの返し方のみが異なります。
tRPCには標準でネイティブFetch API用アダプターが含まれています。このアダプターを使うと、tRPCルーターをRequestハンドラーに変換し、Responseオブジェクトを返せるようになります。
必要なWeb API
tRPCサーバーは以下のFetch APIを使用します:
Request, Response
fetch
Headers
URL
ランタイムがこれらのAPIをサポートしている場合、tRPCサーバーを使用できます。
豆知識:これはブラウザ内でもtRPCサーバーが使えることを意味します!
共通設定
依存関係のインストール
Deno Deployを使用している場合はこの手順をスキップできます
- npm
- yarn
- pnpm
- bun
- deno
npm install @trpc/server @trpc/client zod
yarn add @trpc/server @trpc/client zod
pnpm add @trpc/server @trpc/client zod
bun add @trpc/server @trpc/client zod
deno add npm:@trpc/server npm:@trpc/client npm:zod
Zodは必須依存関係ではありませんが、以下のサンプルルーターで使用されています
AIコーディングエージェントを使用している場合は、コード生成の品質向上のためにtRPCスキルをインストールしてください:
bashnpx @tanstack/intent@latest install
bashnpx @tanstack/intent@latest install
ルーターの作成
まず、クエリ・ミューテーション・サブスクリプションを処理するためのルーターが必要です。
サンプルルーターを以下に示します。router.tsというファイル名で保存してください。
router.ts
router.tstsimport {initTRPC } from '@trpc/server';import {z } from 'zod';import type {Context } from './context';typeUser = {id : string;name : string;bio ?: string;};constusers :Record <string,User > = {};export constt =initTRPC .context <Context >().create ();export constappRouter =t .router ({getUserById :t .procedure .input (z .string ()).query ((opts ) => {returnusers [opts .input ]; // input type is string}),createUser :t .procedure // validate input with Zod.input (z .object ({name :z .string ().min (3),bio :z .string ().max (142).optional (),}),).mutation ((opts ) => {constid =Date .now ().toString ();constuser :User = {id , ...opts .input };users [user .id ] =user ;returnuser ;}),});// export type definition of APIexport typeAppRouter = typeofappRouter ;
router.tstsimport {initTRPC } from '@trpc/server';import {z } from 'zod';import type {Context } from './context';typeUser = {id : string;name : string;bio ?: string;};constusers :Record <string,User > = {};export constt =initTRPC .context <Context >().create ();export constappRouter =t .router ({getUserById :t .procedure .input (z .string ()).query ((opts ) => {returnusers [opts .input ]; // input type is string}),createUser :t .procedure // validate input with Zod.input (z .object ({name :z .string ().min (3),bio :z .string ().max (142).optional (),}),).mutation ((opts ) => {constid =Date .now ().toString ();constuser :User = {id , ...opts .input };users [user .id ] =user ;returnuser ;}),});// export type definition of APIexport typeAppRouter = typeofappRouter ;
ルーターファイルが大きくなりすぎた場合は、ルーターを複数のサブルーターに分割し、それぞれを別ファイルに実装します。その後、それらをマージして単一のルートappRouterにします。
コンテキストの作成
次に、各リクエストごとに作成されるコンテキストが必要です。
サンプルコンテキストを以下に示します。context.tsというファイル名で保存してください:
context.ts
context.tstsimport type {FetchCreateContextFnOptions } from '@trpc/server/adapters/fetch';export functioncreateContext ({req ,resHeaders ,}:FetchCreateContextFnOptions ) {constuser = {name :req .headers .get ('username') ?? 'anonymous' };return {req ,resHeaders ,user };}export typeContext =Awaited <ReturnType <typeofcreateContext >>;
context.tstsimport type {FetchCreateContextFnOptions } from '@trpc/server/adapters/fetch';export functioncreateContext ({req ,resHeaders ,}:FetchCreateContextFnOptions ) {constuser = {name :req .headers .get ('username') ?? 'anonymous' };return {req ,resHeaders ,user };}export typeContext =Awaited <ReturnType <typeofcreateContext >>;
ランタイム固有の設定
Astro
src/pages/trpc/[trpc].tstsimport {fetchRequestHandler } from '@trpc/server/adapters/fetch';import type {APIRoute } from 'astro';import {createContext } from '../../server/context';import {appRouter } from '../../server/router';export constALL :APIRoute = (opts ) => {returnfetchRequestHandler ({endpoint : '/trpc',req :opts .request ,router :appRouter ,createContext ,});};
src/pages/trpc/[trpc].tstsimport {fetchRequestHandler } from '@trpc/server/adapters/fetch';import type {APIRoute } from 'astro';import {createContext } from '../../server/context';import {appRouter } from '../../server/router';export constALL :APIRoute = (opts ) => {returnfetchRequestHandler ({endpoint : '/trpc',req :opts .request ,router :appRouter ,createContext ,});};
Cloudflare Worker
Cloudflare Workersを実行するにはWrangler CLIが必要です
Cloudflare Workerの作成
server.tstsimport {fetchRequestHandler } from '@trpc/server/adapters/fetch';import {createContext } from './context';import {appRouter } from './router';export default {asyncfetch (request :Request ):Promise <Response > {returnfetchRequestHandler ({endpoint : '/trpc',req :request ,router :appRouter ,createContext ,});},};
server.tstsimport {fetchRequestHandler } from '@trpc/server/adapters/fetch';import {createContext } from './context';import {appRouter } from './router';export default {asyncfetch (request :Request ):Promise <Response > {returnfetchRequestHandler ({endpoint : '/trpc',req :request ,router :appRouter ,createContext ,});},};
wrangler dev server.tsを実行すると、エンドポイントがHTTP経由で利用可能になります!
| Endpoint | HTTP URI |
|---|---|
getUser | GET http://localhost:8787/trpc/getUserById?input=INPUT where INPUT is a URI-encoded JSON string. |
createUser | POST http://localhost:8787/trpc/createUser with req.body of type User |
Deno Oak
この手順はDenoがインストール済みであることを前提としています。詳細はDenoのはじめにガイドを参照してください。
router.tsのインポートを更新
router.tstsimport { initTRPC } from 'npm:@trpc/server';import { z } from 'npm:zod';import { Context } from './context.ts';
router.tstsimport { initTRPC } from 'npm:@trpc/server';import { z } from 'npm:zod';import { Context } from './context.ts';
context.tsのインポートを更新
context.tstsimport { FetchCreateContextFnOptions } from 'npm:@trpc/server/adapters/fetch';
context.tstsimport { FetchCreateContextFnOptions } from 'npm:@trpc/server/adapters/fetch';
OakでfetchRequestHandlerを使用する (app.ts)
app.tstsimport { Application, Router } from 'https://deno.land/x/oak/mod.ts';import { fetchRequestHandler } from 'npm:@trpc/server/adapters/fetch';import { createContext } from './context.ts';import { appRouter } from './router.ts';const app = new Application();const router = new Router();router.all('/trpc/(.*)', async (ctx) => {const res = await fetchRequestHandler({endpoint: '/trpc',req: new Request(ctx.request.url, {headers: ctx.request.headers,body:ctx.request.method !== 'GET' && ctx.request.method !== 'HEAD'? ctx.request.body({ type: 'stream' }).value: void 0,method: ctx.request.method,}),router: appRouter,createContext,});ctx.response.status = res.status;ctx.response.headers = res.headers;ctx.response.body = res.body;});app.use(router.routes());app.use(router.allowedMethods());await app.listen({ port: 3000 });
app.tstsimport { Application, Router } from 'https://deno.land/x/oak/mod.ts';import { fetchRequestHandler } from 'npm:@trpc/server/adapters/fetch';import { createContext } from './context.ts';import { appRouter } from './router.ts';const app = new Application();const router = new Router();router.all('/trpc/(.*)', async (ctx) => {const res = await fetchRequestHandler({endpoint: '/trpc',req: new Request(ctx.request.url, {headers: ctx.request.headers,body:ctx.request.method !== 'GET' && ctx.request.method !== 'HEAD'? ctx.request.body({ type: 'stream' }).value: void 0,method: ctx.request.method,}),router: appRouter,createContext,});ctx.response.status = res.status;ctx.response.headers = res.headers;ctx.response.body = res.body;});app.use(router.routes());app.use(router.allowedMethods());await app.listen({ port: 3000 });
Deno Deploy
この手順はDenoがインストール済みであることを前提としています。詳細はDenoのはじめにガイドを参照してください。
動作するサンプルはDeno Deployアプリの例をご覧ください。
router.tsのインポートを更新
router.tstsimport { initTRPC } from 'npm:@trpc/server';import { z } from 'npm:zod';import { Context } from './context.ts';
router.tstsimport { initTRPC } from 'npm:@trpc/server';import { z } from 'npm:zod';import { Context } from './context.ts';
context.tsのインポートを更新
context.tstsimport { FetchCreateContextFnOptions } from 'npm:@trpc/server/adapters/fetch';
context.tstsimport { FetchCreateContextFnOptions } from 'npm:@trpc/server/adapters/fetch';
Deno Deploy関数の作成
server.tstsimport { fetchRequestHandler } from 'npm:@trpc/server/adapters/fetch';import { createContext } from './context.ts';import { appRouter } from './router.ts';function handler(request) {return fetchRequestHandler({endpoint: '/trpc',req: request,router: appRouter,createContext,});}Deno.serve(handler);
server.tstsimport { fetchRequestHandler } from 'npm:@trpc/server/adapters/fetch';import { createContext } from './context.ts';import { appRouter } from './router.ts';function handler(request) {return fetchRequestHandler({endpoint: '/trpc',req: request,router: appRouter,createContext,});}Deno.serve(handler);
deno run --allow-net=:8000 --allow-env ./server.tsを実行すると、エンドポイントがHTTP経由で利用可能になります!
| Endpoint | HTTP URI |
|---|---|
getUser | GET http://localhost:8000/trpc/getUserById?input=INPUT where INPUT is a URI-encoded JSON string. |
createUser | POST http://localhost:8000/trpc/createUser with req.body of type User |
Next.js Edge Runtime
完全なサンプルはこちらをご覧ください。
Remix
app/routes/trpc.$trpc.tstsimport type {ActionFunctionArgs ,LoaderFunctionArgs } from '@remix-run/node';import {fetchRequestHandler } from '@trpc/server/adapters/fetch';import {createContext } from '~/server/context';import {appRouter } from '~/server/router';export constloader = async (args :LoaderFunctionArgs ) => {returnhandleRequest (args );};export constaction = async (args :ActionFunctionArgs ) => {returnhandleRequest (args );};functionhandleRequest (args :LoaderFunctionArgs |ActionFunctionArgs ) {returnfetchRequestHandler ({endpoint : '/trpc',req :args .request ,router :appRouter ,createContext ,});}
app/routes/trpc.$trpc.tstsimport type {ActionFunctionArgs ,LoaderFunctionArgs } from '@remix-run/node';import {fetchRequestHandler } from '@trpc/server/adapters/fetch';import {createContext } from '~/server/context';import {appRouter } from '~/server/router';export constloader = async (args :LoaderFunctionArgs ) => {returnhandleRequest (args );};export constaction = async (args :ActionFunctionArgs ) => {returnhandleRequest (args );};functionhandleRequest (args :LoaderFunctionArgs |ActionFunctionArgs ) {returnfetchRequestHandler ({endpoint : '/trpc',req :args .request ,router :appRouter ,createContext ,});}
SolidStart
src/routes/api/trpc/[trpc].tstsimport {fetchRequestHandler } from '@trpc/server/adapters/fetch';import type {APIEvent } from '@solidjs/start/server';import {createContext } from '../../server/context';import {appRouter } from '../../server/router';consthandler = (event :APIEvent ) =>fetchRequestHandler ({endpoint : '/api/trpc',req :event .request ,router :appRouter ,createContext ,});export {handler asGET ,handler asPOST };
src/routes/api/trpc/[trpc].tstsimport {fetchRequestHandler } from '@trpc/server/adapters/fetch';import type {APIEvent } from '@solidjs/start/server';import {createContext } from '../../server/context';import {appRouter } from '../../server/router';consthandler = (event :APIEvent ) =>fetchRequestHandler ({endpoint : '/api/trpc',req :event .request ,router :appRouter ,createContext ,});export {handler asGET ,handler asPOST };
Vercel Edge Runtime
詳細は公式Vercel Edge Runtimeドキュメントを参照してください。
動作するサンプルはVercel Edge Runtimeアプリの例をご覧ください。
依存関係のインストール
- npm
- yarn
- pnpm
- bun
shnpm install -g edge-runtime
shnpm install -g edge-runtime
shyarn global add edge-runtime
shyarn global add edge-runtime
shpnpm add -g edge-runtime
shpnpm add -g edge-runtime
shbun add -g edge-runtime
shbun add -g edge-runtime
Edge Runtime関数の作成
server.tstsimport {fetchRequestHandler } from '@trpc/server/adapters/fetch';import {createContext } from './context';import {appRouter } from './router';// Vercel Edge Runtime uses Service Worker-style addEventListeneraddEventListener ('fetch', (event : any) => {returnevent .respondWith (fetchRequestHandler ({endpoint : '/trpc',req :event .request ,router :appRouter ,createContext ,}),);});
server.tstsimport {fetchRequestHandler } from '@trpc/server/adapters/fetch';import {createContext } from './context';import {appRouter } from './router';// Vercel Edge Runtime uses Service Worker-style addEventListeneraddEventListener ('fetch', (event : any) => {returnevent .respondWith (fetchRequestHandler ({endpoint : '/trpc',req :event .request ,router :appRouter ,createContext ,}),);});
edge-runtime --listen server.ts --port 3000を実行すると、エンドポイントがHTTP経由で利用可能になります!
| Endpoint | HTTP URI |
|---|---|
getUser | GET http://localhost:3000/trpc/getUserById?input=INPUT where INPUT is a URI-encoded JSON string. |
createUser | POST http://localhost:3000/trpc/createUser with req.body of type User |