Does it support YAML files as well as JSON?

Yes, the skill can process both OpenAPI JSON and YAML file formats.

Which versions of OpenAPI are supported?

This skill is specifically designed for OpenAPI 3.0.x specifications to ensure the highest compatibility and accuracy in type generation.

Will it generate the actual API call logic?

No, this skill focuses on data modeling. It generates the interfaces and type guards, which you can then use within your preferred fetching library (like Axios or Fetch).

How are optional fields handled?

The skill checks the 'required' array in your OpenAPI schema. Fields not listed there are automatically marked as optional (?) in the generated TypeScript interfaces.

Can it handle circular references?

The skill includes logic to detect and manage complex references, defaulting to type aliases or 'unknown' with warnings if a direct resolution isn't possible.

OpenAPI to TypeScript

Name: OpenAPI to TypeScript
Author: softaworks

bysoftaworks

•

347

•

API Development

Transforms OpenAPI 3.0 specifications into robust TypeScript interfaces and runtime type guards.

This skill streamlines the development of type-safe API clients and backend services by translating OpenAPI 3.0 JSON or YAML specifications directly into high-quality TypeScript code. It handles complex schemas, including enums, unions (oneOf), and intersections (allOf), while automatically generating runtime type guards for rigorous data validation. By providing consistent naming conventions for request/response types and intelligently resolving internal $ref references, it ensures a seamless, error-free bridge between API documentation and frontend implementation.

Key Features

01Supports OpenAPI 3.0.x in both JSON and YAML formats

02Handles complex schema compositions like oneOf and allOf

03Generates TypeScript interfaces with JSDoc comments from descriptions

04347 GitHub stars

05Creates runtime type guards for validating API payloads

06Automatically maps OpenAPI formats to precise TypeScript types and comments

Use Cases

01Implementing runtime validation for external API data using generated type guards

02Synchronizing frontend data structures with evolving backend API specifications

03Generating type-safe request and response models for API integration

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add softaworks/agent-toolkit openapi-to-typescript

For use in Claude.ai and ChatGPT

Download Skill