Utilisation avec Express.js

Traduction Bêta Non Officielle

Cette page a été traduite par PageTurner AI (bêta). Non approuvée officiellement par le projet. Vous avez trouvé une erreur ? Signaler un problème →

Exemple d'application

Description	URL	Links
Express server & procedure calls with node.js.	n/a	CodeSandbox Source

Comment ajouter tRPC à un projet Express.js existant

1. Installer les dépendances

bash
yarn add @trpc/server zod

bash
yarn add @trpc/server zod

Zod n'est pas obligatoire mais est utilisé dans l'exemple de routeur ci-dessous.

2. Créer un routeur tRPC

Implémentez votre routeur tRPC. Un exemple de routeur est fourni ci-dessous :

server.ts
ts
import * as trpc from '@trpc/server';
import { z } from 'zod';
const appRouter = trpc
  .router()
  .query('getUser', {
    input: z.string(),
    async resolve(req) {
      req.input; // string
      return { id: req.input, name: 'Bilbo' };
    },
  })
  .mutation('createUser', {
    // validate input with Zod
    input: z.object({ name: z.string().min(5) }),
    async resolve(req) {
      // use your ORM of choice
      return await UserModel.create({
        data: req.input,
      });
    },
  });
// export type definition of API
export type AppRouter = typeof appRouter;

server.ts
ts
import * as trpc from '@trpc/server';
import { z } from 'zod';
const appRouter = trpc
  .router()
  .query('getUser', {
    input: z.string(),
    async resolve(req) {
      req.input; // string
      return { id: req.input, name: 'Bilbo' };
    },
  })
  .mutation('createUser', {
    // validate input with Zod
    input: z.object({ name: z.string().min(5) }),
    async resolve(req) {
      // use your ORM of choice
      return await UserModel.create({
        data: req.input,
      });
    },
  });
// export type definition of API
export type AppRouter = typeof appRouter;

Si votre fichier de routeur devient trop volumineux, découpez-le en plusieurs sous-routeurs, chacun implémenté dans son propre fichier. Ensuite, fusionnez-les en un seul routeur racine appRouter.

3. Utiliser l'adaptateur Express.js

tRPC inclut un adaptateur pour Express.js prêt à l'emploi. Cet adaptateur vous permet de transformer votre routeur tRPC en middleware Express.js.

server.ts
ts
import * as trpcExpress from '@trpc/server/adapters/express';
const appRouter = /* ... */;
const app = express();
// created for each request
const createContext = ({
  req,
  res,
}: trpcExpress.CreateExpressContextOptions) => ({}) // no context
type Context = trpc.inferAsyncReturnType<typeof createContext>;
app.use(
  '/trpc',
  trpcExpress.createExpressMiddleware({
    router: appRouter,
    createContext,
  })
);
app.listen(4000);

server.ts
ts
import * as trpcExpress from '@trpc/server/adapters/express';
const appRouter = /* ... */;
const app = express();
// created for each request
const createContext = ({
  req,
  res,
}: trpcExpress.CreateExpressContextOptions) => ({}) // no context
type Context = trpc.inferAsyncReturnType<typeof createContext>;
app.use(
  '/trpc',
  trpcExpress.createExpressMiddleware({
    router: appRouter,
    createContext,
  })
);
app.listen(4000);

Vos endpoints sont maintenant disponibles via HTTP !

Endpoint	HTTP URI
getUser	GET http://localhost:4000/trpc/getUser?input=INPUT where INPUT is a URI-encoded JSON string.
createUser	POST http://localhost:4000/trpc/createUser with req.body of type {name: string}