createOpenApiBuilder

createOpenApiBuilder(options): OpenApiMiddlewareBuilder

Creates a new OpenAPI middleware builder.

This is the recommended entry point for creating custom OpenAPI middleware. It returns a fluent builder that allows you to chain configuration methods.

Parameters

options

Partial<ModelRouterOptions<unknown>>

Router options containing the OpenAPI configuration

Returns

OpenApiMiddlewareBuilder

A new OpenApiMiddlewareBuilder instance

Example

import {createOpenApiBuilder} from "./openApiBuilder";

const statsMiddleware = createOpenApiBuilder(options)
  .withTags(["analytics"])
  .withSummary("Get usage statistics")
  .withQueryParameter("startDate", {type: "string", format: "date"})
  .withQueryParameter("endDate", {type: "string", format: "date"})
  .withResponse<{totalUsers: number; activeUsers: number}>(200, {
    totalUsers: {type: "number", description: "Total registered users"},
    activeUsers: {type: "number", description: "Users active in period"},
  })
  .build();

router.get("/analytics/stats", statsMiddleware, getStatsHandler);