For now, look athttps://www.npmjs.com/package/trpc-to-openapi for an alternative

trpc-openapi is maintained by ProsePilot - simple, fast and free onlinewriting tools.

OpenAPI support fortRPC 🧩

Usage

# npmnpm install trpc-openapi# yarnyarn add trpc-openapi

import{initTRPC}from'@trpc/server';import{OpenApiMeta}from'trpc-openapi';constt=initTRPC.meta<OpenApiMeta>().create();/* 👈 */

exportconstappRouter=t.router({sayHello:t.procedure.meta({/* 👉 */openapi:{method:'GET',path:'/say-hello'}}).input(z.object({name:z.string()})).output(z.object({greeting:z.string()})).query(({ input})=>{return{greeting:`Hello${input.name}!`};});});

import{generateOpenApiDocument}from'trpc-openapi';import{appRouter}from'../appRouter';/* 👇 */exportconstopenApiDocument=generateOpenApiDocument(appRouter,{title:'tRPC OpenAPI',version:'1.0.0',baseUrl:'http://localhost:3000',});

importhttpfrom'http';import{createOpenApiHttpHandler}from'trpc-openapi';import{appRouter}from'../appRouter';constserver=http.createServer(createOpenApiHttpHandler({router:appRouter}));/* 👈 */server.listen(3000);

// client.tsconstres=awaitfetch('http://localhost:3000/say-hello?name=James',{method:'GET'});constbody=awaitres.json();/* { greeting: 'Hello James!' } */

Requirements

HTTP Requests

Path parameters

Query parameters

// RouterexportconstappRouter=t.router({sayHello:t.procedure.meta({openapi:{method:'GET',path:'/say-hello/{name}'/* 👈 */}}).input(z.object({name:z.string()/* 👈 */,greeting:z.string()})).output(z.object({greeting:z.string()})).query(({ input})=>{return{greeting:`${input.greeting}${input.name}!`};});});// Clientconstres=awaitfetch('http://localhost:3000/say-hello/James?greeting=Hello'/* 👈 */,{method:'GET',});constbody=awaitres.json();/* { greeting: 'Hello James!' } */

Request body

// RouterexportconstappRouter=t.router({sayHello:t.procedure.meta({openapi:{method:'POST',path:'/say-hello/{name}'/* 👈 */}}).input(z.object({name:z.string()/* 👈 */,greeting:z.string()})).output(z.object({greeting:z.string()})).mutation(({ input})=>{return{greeting:`${input.greeting}${input.name}!`};});});// Clientconstres=awaitfetch('http://localhost:3000/say-hello/James'/* 👈 */,{method:'POST',headers:{'Content-Type':'application/json'},body:JSON.stringify({greeting:'Hello'}),});constbody=awaitres.json();/* { greeting: 'Hello James!' } */

Custom headers

HTTP Responses

Authorization

Server

import{TRPCError,initTRPC}from'@trpc/server';import{OpenApiMeta}from'trpc-openapi';typeUser={id:string;name:string};constusers:User[]=[{id:'usr_123',name:'James',},];exporttypeContext={user:User|null};exportconstcreateContext=async({ req, res}):Promise<Context>=>{letuser:User|null=null;if(req.headers.authorization){constuserId=req.headers.authorization.split(' ')[1];user=users.find((_user)=>_user.id===userId);}return{ user};};constt=initTRPC.context<Context>().meta<OpenApiMeta>().create();exportconstappRouter=t.router({sayHello:t.procedure.meta({openapi:{method:'GET',path:'/say-hello',protect:true/* 👈 */}}).input(z.void())// no input expected.output(z.object({greeting:z.string()})).query(({ input, ctx})=>{if(!ctx.user){thrownewTRPCError({message:'User not found',code:'UNAUTHORIZED'});}return{greeting:`Hello${ctx.user.name}!`};}),});

Client

constres=awaitfetch('http://localhost:3000/say-hello',{method:'GET',headers:{Authorization:'Bearer usr_123'}/* 👈 */,});constbody=awaitres.json();/* { greeting: 'Hello James!' } */

Examples

With Express

import{createExpressMiddleware}from'@trpc/server/adapters/express';importexpressfrom'express';import{createOpenApiExpressMiddleware}from'trpc-openapi';import{appRouter}from'../appRouter';constapp=express();app.use('/api/trpc',createExpressMiddleware({router:appRouter}));app.use('/api',createOpenApiExpressMiddleware({router:appRouter}));/* 👈 */app.listen(3000);

With Next.js

// pages/api/[...trpc].tsimport{createOpenApiNextHandler}from'trpc-openapi';import{appRouter}from'../../server/appRouter';exportdefaultcreateOpenApiNextHandler({router:appRouter});

With AWS Lambda

import{createOpenApiAwsLambdaHandler}from'trpc-openapi';import{appRouter}from'./appRouter';exportconstopenApi=createOpenApiAwsLambdaHandler({router:appRouter});

With Fastify

import{fastifyTRPCPlugin}from'@trpc/server/adapters/fastify';importFastifyfrom'fastify';import{fastifyTRPCOpenApiPlugin}from'trpc-openapi';import{appRouter}from'./router';constfastify=Fastify();asyncfunctionmain(){awaitfastify.register(fastifyTRPCPlugin,{router:appRouter});awaitfastify.register(fastifyTRPCOpenApiPlugin,{router:appRouter});/* 👈 */awaitfastify.listen({port:3000});}main();

Types

GenerateOpenApiDocumentOptions

OpenApiMeta

CreateOpenApiNodeHttpHandlerOptions

License

Contact