@connectrpc/connect-fastify

Connect is a family of libraries for building and consuming APIs on different languages and platforms, and @connectrpc/connect brings type-safe APIs with Protobuf to TypeScript.

@connectrpc/connect-fastify provides a plugin for fastify, the fast and low overhead web framework, for Node.js.

fastifyConnectPlugin()

Plug your Connect RPCs into a fastify server.

1// connect.ts
2import { ConnectRouter } from "@connectrpc/connect";
3
4export default function (router: ConnectRouter) {
5  // implement rpc Say(SayRequest) returns (SayResponse)
6  router.rpc(ElizaService, ElizaService.methods.say, async (req) => ({
7    sentence: `you said: ${req.sentence}`,
8  }));
9}

1// server.ts
2import { fastify } from "fastify";
3+ import routes from "connect";
4+ import { fastifyConnectPlugin } from "@connectrpc/connect-fastify";
5
6const server = fastify({
7  http2: true,
8});
9
10+ await server.register(fastifyConnectPlugin, {
11+  routes
12+ });
13
14await server.listen({
15  host: "localhost",
16  port: 8080,
17});

With that server running, you can make requests with any gRPC, gRPC-Web, or Connect client.

buf curl with the gRPC protocol:

1buf curl --schema buf.build/connectrpc/eliza \
2  --protocol grpc --http2-prior-knowledge \
3  -d '{"sentence": "I feel happy."}' \
4  http://localhost:8080/connectrpc.eliza.v1.ElizaService/Say

curl with the Connect protocol:

1curl \
2    --header "Content-Type: application/json" \
3    --data '{"sentence": "I feel happy."}' \
4    --http2-prior-knowledge \
5    http://localhost:8080/connectrpc.eliza.v1.ElizaService/Say

Node.js with the gRPC protocol (using a transport from @connectrpc/connect-node):

1import { createClient } from "@connectrpc/connect";
2import { createGrpcTransport } from "@connectrpc/connect-node";
3import { ElizaService } from "./gen/eliza_connect.js";
4
5const transport = createGrpcTransport({
6  baseUrl: "http://localhost:8080",
7  httpVersion: "2",
8});
9
10const client = createClient(ElizaService, transport);
11const { sentence } = await client.say({ sentence: "I feel happy." });
12console.log(sentence); // you said: I feel happy.

A client for the web browser actually looks identical to this example - it would simply use createConnectTransport from @connectrpc/connect-web instead.

Getting started

To get started with Connect, head over to the docs for a tutorial, or take a look at our example.