skills.rest
santanapol
santanapolCOMMUNITY
Explore all skills by this author →
GitHub

api-and-interface-design

Design backward-compatible REST APIs with standardized error responses and input validation.

Updated May 27, 2026
Search Tags:#typescript#graphql#backward-compatibility#api-validation#api-design#rest-api#interface-design
One-click install
npx skills add https://github.com/santanapol/agent-skills --skill api-and-interface-design-santanapol
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-and-interface-design
Source: https://github.com/santanapol/agent-skills/tree/main/.cursor/skills/api-and-interface-design
Command: npx skills add https://github.com/santanapol/agent-skills --skill api-and-interface-design-santanapol

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill solves the common pain points of fragile, inconsistent APIs and interfaces that break consumer workflows, introduce unpredictable system behavior, and create high maintenance costs when public interfaces change without proper planning and backward compatibility safeguards.

Core Features & Use Cases

  • Proven Design Principles: Includes Hyrum's Law, the One-Version Rule, and contract-first design to prevent unintended breaking changes and dependency conflicts.
  • Standardized API Patterns: Provides consistent templates for REST endpoint structure, pagination, filtering, error handling, and TypeScript interface implementation including discriminated unions and branded types.
  • Use Case Example: Use this Skill when building a new task management REST API to ensure all endpoints follow consistent naming, return standardized error responses, and support backward-compatible updates as new features are added.

Quick Start

Use the api-and-interface-design skill to design a backward-compatible REST API for a user profile service with standardized error responses and input validation at all system boundaries.

Frequently Asked Questions about api-and-interface-design

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

FAQPage Schema
How do I design a backward-compatible REST API that avoids breaking changes?▼

To design a backward-compatible REST API, this Skill applies Hyrum's Law, the One-Version Rule, and contract-first design principles to prevent unintended breaking changes and dependency conflicts for consumers.

What is the best way to standardize error responses and input validation at system boundaries?▼

Standardizing error responses and input validation requires applying consistent API patterns for system boundaries, ensuring predictable behavior and standardized error semantics across all endpoint interactions.

How do I define module boundaries between development teams for frontend-backend integration?▼

Defining module boundaries between development teams involves establishing clear interface boundaries and predictable naming conventions for API resources, fields, and TypeScript interface implementations.

Can I use TypeScript discriminated unions and branded types for interface implementation?▼

Yes, you can use TypeScript discriminated unions and branded types for interface implementation, applying standardized API patterns to ensure type safety and predictable system behavior.

Does this approach work for GraphQL endpoint design and REST API pagination patterns?▼

Yes, this approach works for GraphQL endpoint design and REST API pagination patterns, providing consistent templates for endpoint structure, filtering, and predictable naming conventions across protocols.

Related Skills

Explore More Software Engineering Skills→
davidYichengWeidavidYichengWei
159

bp-architecture-design

Apply architecture principles to partition modules, manage dependencies, and define interfaces.

Community
Advanced
camilooscargbaptistacamilooscargbaptista
7

api-documentation

Generate and review OpenAPI 3.1 specs for REST and GraphQL APIs.

Community
Intermediate
rsmdtrsmdt
381

api-design-patterns

Apply standardized REST and GraphQL design patterns to API contracts and versioning.

Community
Advanced
erichowenserichowens
181

api-architect

Design and validate REST, GraphQL, and gRPC API contracts and architectures.

Community
Advanced