api-design

Generates complete front- and back-end API blueprints from feature descriptions.

13|3|Updated Mar 27, 2026

Search Tags:#versioning #openapi #rest #endpoints #schemas #api-design

Ready to run

npx skills add https://github.com/heaptracetechnology/heaptrace-skills --skill api-design-heaptracetechnology

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/heaptracetechnology/heaptrace-skills/tree/main/architect/api-design
Command: npx skills add https://github.com/heaptracetechnology/heaptrace-skills --skill api-design-heaptracetechnology

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Design RESTful APIs — endpoints, schemas, error codes, and versioning — to convert feature requirements into production-ready API contracts that guide implementation and coordination between frontend and backend.

Core Features & Use Cases

Flow-driven API design process from feature to contract, including endpoints, data models, schemas, and versioning strategy.
OpenAPI-first guidance with validation rules, error handling patterns, pagination, and security recommendations.
Collaboration and governance for frontend-backend teams to maintain consistency across releases.

Quick Start

Provide a complete API design contract for the given feature, including endpoints, schemas, error handling, and versioning strategy.

Frequently Asked Questions about api-design

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I design a REST API from feature requirements?▼

A REST API design process converts feature requirements into a production-ready API contract by defining endpoints, data models, schemas, and versioning strategy. It enforces OpenAPI-style validation rules, error handling patterns, pagination, and security recommendations to guide implementation.

What is the best way to version REST API endpoints and schemas?▼

Versioning REST API endpoints and schemas requires applying an OpenAPI-first design process that enforces a clear versioning strategy. This maintains consistency across releases and coordinates frontend-backend team governance for production-ready API contracts.

How do I create an OpenAPI specification for frontend-backend coordination?▼

Creating an OpenAPI specification for frontend-backend coordination involves translating feature requirements into a versioned API contract. This enforces consistent response shapes, schemas, error formats, authentication, and pagination to maintain governance across team releases.

Can I use this API design process for an API redesign?▼

This API design process applies to API redesigns by enforcing OpenAPI-style schemas, error formats, authentication, pagination, and versioning. It translates updated feature requirements into a complete, versioned API specification for production-ready contracts.

What should a production-ready API contract include?▼

A production-ready API contract includes endpoints, schemas, error handling patterns, pagination, security recommendations, and a versioning strategy. It enforces OpenAPI-style validation rules and consistent response shapes to guide implementation and frontend-backend coordination.

How do I handle error formats and pagination in REST API design?▼

Handling error formats and pagination in REST API design involves applying OpenAPI-first guidance with validation rules and consistent response shapes. This enforces standardized error handling patterns and pagination within the versioned API specification.