API Design

Automate REST/JSON API design with a 5-tier parameter model and pre-commit validation.

21|2|Updated Oct 8, 2025
One-click install
npx skills add https://github.com/yaleh/meta-cc --skill api-design-yaleh
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: API Design
Source: https://github.com/yaleh/meta-cc/tree/main/.claude/skills/api-design
Command: npx skills add https://github.com/yaleh/meta-cc --skill api-design-yaleh

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill provides a methodical approach to API design, improving consistency, safety, and maintainability across endpoints using a 6-pattern framework, audit-first validation, and example-driven guidelines.

Core Features & Use Cases

  • Deterministic parameter patterns: 5-tier parameter system for endpoint design and validation.
  • Safe refactoring guidance: Techniques to evolve APIs without breaking clients.
  • Audit-first validation & documentation: Pre-commit style checks and example-driven docs.
  • Use cases: Designing new APIs, enforcing API quality gates, and standardizing multi-endpoint redesigns.

Quick Start

Use this Skill to outline a new API's structure and validation rules, then apply the patterns to a 6-endpoint example.

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 with consistent validation patterns?

API design uses a 5-tier parameter system to categorize endpoint inputs deterministically, ensuring consistent validation rules across all endpoints. This framework standardizes how required, optional, and derived parameters are validated and documented throughout your REST API.

What's the best way to enforce API quality gates before deployment?

Pre-commit style checks enforce validation and documentation standards at code review time. Audit-first workflows catch inconsistencies early, preventing breaking changes and ensuring endpoints meet the 6-pattern framework before they reach production.

How can I refactor an existing API without breaking client integrations?

Safe refactoring guidance within the 6-pattern framework shows how to evolve endpoints incrementally. The Skill provides techniques to change validation rules and structure while maintaining backward compatibility with existing clients.

Can I use this approach to standardize multiple endpoints across a large API?

Yes. The 5-tier parameter model and 6-pattern framework scale across multi-endpoint redesigns. Apply deterministic patterns consistently to enforce uniform validation, documentation, and structure across your entire REST API surface.

How do I generate API documentation from validation rules automatically?

Example-driven documentation scaffolding generates specifications directly from your parameter definitions and validation patterns. This ties documentation to actual endpoint behavior, keeping specs in sync with code.

Does this work for JSON APIs, or only REST endpoints?

The framework applies to REST and JSON APIs. The 5-tier parameter system and validation patterns work with any endpoint structure that accepts and validates parameters, not just REST conventions.