OpenAPI Reference Plugin (Swagger/Scalar)

Provides API reference documentation powered by Scalar or Swagger UI, along with the OpenAPI specification.

Relies on the OpenAPI Generator.

Setup

import { ZodToJsonSchemaConverter } from '@orpc/zod/zod4'
import { OpenAPIReferencePlugin } from '@orpc/openapi/plugins'

const handler = new OpenAPIHandler(router, {
  plugins: [
    new OpenAPIReferencePlugin({
      docsProvider: 'swagger', // default: 'scalar'
      schemaConverters: [
        new ZodToJsonSchemaConverter(),
      ],
      specGenerateOptions: {
        info: {
          title: 'ORPC Playground',
          version: '1.0.0',
        },
        servers: [
          { url: 'https://api.example.com/v1' },
        ],
      },
    }),
  ]
})

Default paths: client at /, OpenAPI spec at /spec.json. Customize via docsPath and specPath options.