HttpApiTransformer

Renders parsed OpenAPI operations into generated Effect HttpApi source code.

This module maps normalized OpenAPI metadata, tags, request bodies, responses, and security requirements into import declarations, HttpApi groups, endpoint definitions, schema annotations, and middleware classes. The rendered TypeScript can be emitted by the OpenAPI generator as an executable Effect HttpApi module.

2 exports Added in v4.0.0 Source

Code Generation

imports

Added in v4.0.0 Source

Render the import declarations required by generated HttpApi source.

Details

The schema namespace import is named by the caller so generated code can avoid collisions with symbols already present in the output module. Multipart support is included only when the parsed OpenAPI document needs it.

Signature

declare function imports(
  importName: string,
  options?: {
    readonly multipart?: boolean;
  },
): string;

toImplementation

Added in v4.0.0 Source

Convert a parsed OpenAPI document into Effect HttpApi source code.

Details

The generated implementation contains security declarations, reusable middleware classes, HttpApi groups, endpoint definitions, and OpenAPI annotations derived from the parsed operation metadata.

Signature

declare function toImplementation(_importName: string, name: string, parsed: ParsedOpenApi): string;