Redirect Response

Return a standard HTTP redirect response in oRPC OpenAPI.

Basic Usage

Combine successStatus and outputStructure:

const redirect = os
  .route({
    method: 'GET',
    path: '/redirect',
    successStatus: 307,
    outputStructure: 'detailed'
  })
  .handler(async () => {
    return {
      headers: {
        location: 'https://orpc.dev',
      },
    }
  })

Limitations

When using OpenAPILink, oRPC treats the redirect as a normal response. Some environments like browsers may restrict access to the redirect response, potentially causing errors. Server environments like Node.js handle this without issue.