Skip to content
Effect 4.0 is here. One ecosystem. Zero dependencies.

OpenApiGenerator

The OpenApiGenerator module orchestrates converting OpenAPI and Swagger documents into generated Effect source.

It normalizes Swagger 2.0 input, resolves local references, builds the parsed operation model, registers request and response schemas, applies HttpApi-specific adaptations such as multipart helpers and security metadata, emits warnings for unsupported or lossy OpenAPI features, and then delegates final rendering to the HttpClient or HttpApi code generators.

8 exports Since v4.0.0 Source

Constructors

make

Since v4.0.0

Constructs the OpenAPI generator service implementation.

Signature

declare const make: Effect<{
  generate: (...args: [_: OpenAPISpec, options: OpenApiGenerateOptions]) => Effect;
}, never, never>

Layers

layerTransformerSchema

Since v4.0.0

Layer providing an OpenAPI generator for Schema-backed HTTP client and HttpApi output.

Signature

declare const layerTransformerSchema: Layer.Layer<OpenApiGenerator>

layerTransformerTs

Since v4.0.0

Layer providing an OpenAPI generator for type-only HTTP client output.

Signature

declare const layerTransformerTs: Layer.Layer<OpenApiGenerator>

Models

OpenApiGeneratorFormat

type
Since v4.0.0

Output targets supported by the OpenAPI generator.

Signature

type OpenApiGeneratorFormat = "httpclient" | "httpclient-type-only" | "httpapi"

OpenApiGeneratorWarning

interface
Since v4.0.0

Describes a non-fatal issue encountered while mapping an OpenAPI operation to generated Effect source.

Signature

interface OpenApiGeneratorWarning {
  readonly code: OpenApiGeneratorWarningCode;
  readonly message: string;
  readonly method?: "get" | "post" | "put" | "delete" | "patch" | "head" | "options" | "trace" | "query";
  readonly operationId?: string;
  readonly path?: string;
}

OpenApiGeneratorWarningCode

type
Since v4.0.0

Stable identifiers for non-fatal OpenAPI generation warnings.

Signature

type OpenApiGeneratorWarningCode = "cookie-parameter-dropped" | "additional-tags-dropped" | "sse-operation-skipped" | "response-headers-ignored" | "optional-request-body-approximated" | "default-response-remapped" | "security-and-downgraded" | "no-body-method-request-body-skipped" | "naming-collision"

Options

OpenApiGenerateOptions

interface
Since v4.0.0

Options that control one OpenAPI generation run.

Signature

interface OpenApiGenerateOptions {
  readonly format: OpenApiGeneratorFormat;
  readonly name: string;
  readonly onEnter?: (js: JsonSchema) => JsonSchema;
  readonly onWarning?: (warning: OpenApiGeneratorWarning) => void;
}

Services

OpenApiGenerator

Since v4.0.0

Service for turning OpenAPI or Swagger specifications into generated Effect HTTP client or HttpApi source code.

Signature

declare class OpenApiGenerator extends Shape<"OpenApiGenerator", {
  readonly generate: (spec: OpenAPISpec, options: OpenApiGenerateOptions) => Effect<string>;
}, this> {
  constructor(_: never);
}