api-generation

What problem does it solve?

This Skill eliminates the tedious and error-prone manual process of writing and maintaining frontend API clients. It automates the generation of type-safe TypeScript React Query hooks directly from your Go backend's Swagger comments, ensuring your frontend is always perfectly in sync with your backend API, saving countless hours of debugging and manual updates.

Core Features & Use Cases

• One-Command Generation: Use make api to automatically generate swagger.json from Go comments and then TypeScript hooks via Orval.
• Type-Safe Frontend Client: Provides strongly typed API requests and responses, reducing runtime errors and improving developer experience.
• Clear Workflow for New Endpoints: Guides you through adding Swagger comments to Go handlers and regenerating the client.
• Use Case: After adding a new /products endpoint to your Go backend, use make api to automatically generate the corresponding useGetProducts and usePostProducts React Query hooks for the frontend, ensuring immediate and type-safe consumption.

Quick Start

Explain the steps to add a new API endpoint in the Go backend, including Swagger comments, and then generate the updated TypeScript client for the frontend using the make api command.