openapi-to-typescript

Overview

The OpenAPI to TypeScript skill converts OpenAPI 3.0 specifications (JSON or YAML) into TypeScript interfaces and type guards. It provides a complete workflow from reading and validating the spec to generating typed interfaces with JSDoc comments, including proper handling of primitives, format modifiers, enums, unions (oneOf), intersections (allOf), arrays, and nested objects.

Key Features

• Complete Type Mapping - Converts OpenAPI primitives, format modifiers (uuid, date, email, uri), enums, oneOf unions, allOf intersections, arrays, and nested objects to TypeScript equivalents
• Type Guard Generation - Automatically creates runtime type guards alongside interfaces for safe type checking
• Schema and Endpoint Coverage - Extracts types from both components/schemas and paths (request/response types) for full API coverage
• Auto-Generated File Headers - Includes source file reference, timestamp, and DO NOT EDIT warnings in generated output
• OpenAPI Validation - Validates the spec file before processing, checking for required openapi version, paths, and components fields

Who is this for?

This skill is for TypeScript developers who work with REST APIs defined by OpenAPI 3.0 specifications and need to generate type-safe interfaces. It is particularly useful for frontend and backend teams who want to maintain type consistency between their API specification and TypeScript codebase without manually writing and updating interfaces.