@formkit-gov/openapi

Generate Zod schemas and TypeScript types from OpenAPI specifications for schema federation.

Status

Coming in v0.5.0 - This package is currently in development.

See the roadmap for release timeline.

Overview

The openapi package enables schema federation by generating Zod schemas from your backend’s OpenAPI specification, ensuring frontend validation matches backend requirements.

Planned Features

Feature	Description
OpenAPI 3.0/3.1 parser	Full specification support
Zod schema generator	Generate type-safe schemas
TypeScript types	Generate TypeScript interfaces
CLI tool	Command-line interface
Watch mode	Auto-regenerate on spec changes
Reference resolution	Handle `$ref` references
Circular references	Proper handling of circular schemas

Planned CLI Usage


# Generate Zod schemas from OpenAPI spec
npx formkit-openapi generate ./openapi.yaml -o ./src/schemas
 
# Watch mode for development
npx formkit-openapi generate ./openapi.yaml -o ./src/schemas --watch
 
# Validate OpenAPI specification
npx formkit-openapi validate ./openapi.yaml

Planned API Usage


import { generateSchemas } from '@formkit-gov/openapi';
 
const schemas = await generateSchemas('./openapi.yaml', {
  output: './src/schemas',
  format: 'esm',
});

Installation


npm install @formkit-gov/openapi


pnpm add @formkit-gov/openapi


yarn add @formkit-gov/openapi


bun add @formkit-gov/openapi

@formkit-gov/core - Generated schemas extend core patterns
@formkit-gov/react - Use generated schemas with form components