openapi-to-typescript

Topics in the source

• OpenAPI to TypeScript
• When to Use
• Workflow
• OpenAPI Validation
• Type Mapping
• Primitives
• Format Modifiers
• Complex Types

Converts OpenAPI 3.0 specifications to TypeScript interfaces and type guards. Input: OpenAPI file (JSON or YAML) Output: TypeScript file with interfaces and type guards "generate types from openapi" "convert openapi to typescript" "create API interfaces" "generate types from spec" 1. Request the OpenAPI file path (if not provided) 2. Read and validate the file (must be OpenAPI 3.0.x) 3. Extract schemas from components/schemas 4. Extract endpoints from paths (request/response types) 5. Generate TypeScript (interfaces + type guards) 6. Ask where to save (default: types/api.ts in current directory) 7. Write the file Check before processing: If invalid, report the error and stop. | OpenAPI | TypeScript | |-------------|--------------| | string | string | | number | number | | integer | number | | boolean | boolean | | null | null | | Format | TypeScript | |---------------|-------------------------| | uuid | string (comment UUID) | | date | string (comment date) | | date-time | string (comment ISO) | | email | string (comment email)| | uri | string (comment URI) | Object: Array: Enum: oneOf (Union): allOf (Intersection/Extends): For each schema in components/schemas: Use OpenAPI descrip

This is an excerpt. Refer to the complete source and its current requirements.