openapi-ts/openapi-typescript
Openapi Typescript
openapi-typescript is an OpenAPI TypeScript type generator and schema transformer. It converts JSON or YAML OpenAPI specification files into static TypeScript type definitions to provide end-to-end API type safety.
The tool functions as a static type generator that transforms external API definitions into interfaces and types. It focuses on zero-runtime type enforcement, ensuring that data consistency is maintained via the TypeScript type system without adding overhead to production bundles.
The project covers API type safety and schema conversion, facilitating the validation of request bodies and responses against a defined schema. It supports client-side validation and frontend API integration by verifying that network calls and mock data adhere to the structures defined in an OpenAPI document.
Features
- Static Type Generators - Generates static TypeScript definition files from API schemas to provide compile-time safety without runtime overhead.
- OpenAPI to Type Conversions - Transforms JSON or YAML API specifications into static type definitions for frontend and backend use.
- OpenAPI Specification Parsers - Provides the core logic for ingesting and normalizing OpenAPI JSON or YAML specification files.
- Type Safety - Implements architectural patterns that propagate API type definitions across the entire application stack.
- Zero-Runtime Enforcement - Ensures data consistency by relying on the TypeScript type system instead of executing validation in production.
- Schema-to-Type Transformations - Transforms JSON or YAML OpenAPI schemas into typed definitions without adding runtime overhead to bundles.
- Type Definition Generators - Automatically synthesizes static type declaration files from API schemas for use in development.
- TypeScript Type Synthesis - Synthesizes static TypeScript interfaces from OpenAPI schema definitions for end-to-end type safety.
- Schema-Based Type Synthesis - Automatically synthesizes TypeScript interfaces and types directly from structured OpenAPI schema documents.
- OpenAPI to TypeScript Converters - Transforms local or remote OpenAPI specification files into typed definitions for application-wide consistency.
- OpenAPI Processors - Processes OpenAPI specification files to verify that request and response structures are correct.
- Data Schema Validation - Enforces type safety and data consistency by verifying that request and response bodies match the API schema.
- Recursive Type Resolution - Implements recursive traversal of schema hierarchies to resolve nested and circular type references.
- API Integration Layers - Provides a typed network layer that synchronizes backend schema definitions with frontend clients.
- Type-Safe API Integrations - Synchronizes API schemas with TypeScript types to ensure safe data exchange across network boundaries.
