Atelier Typescript Api Design

What it does

This skill assists in designing robust and maintainable APIs using TypeScript. It focuses on generating well-structured code with appropriate types, interfaces, and error handling based on provided specifications or requirements. The goal is to produce clean, testable API designs ready for implementation.

When to use it

• You need help defining the structure of a new REST API endpoint.
• You want to refactor an existing API design to improve type safety and clarity.
• You are creating TypeScript interfaces or types for data transfer objects (DTOs).
• You require assistance in generating documentation for your API designs.

Key capabilities

• Generates TypeScript code for APIs
• Creates interfaces and types based on specifications
• Focuses on robust error handling
• Produces clean, testable designs

Example prompts

• "Design a TypeScript API endpoint for creating users with fields: name, email, password."
• "Generate a TypeScript interface representing a product object with properties id, name, price, and description."
• "Create types for an API that retrieves customer data, including error handling for invalid user IDs."

Tips & gotchas

The skill is most effective when provided with clear specifications or requirements. Vague prompts may result in less useful output; be as specific as possible about the desired API structure and functionality.