api-design-principles

Standardize REST and GraphQL API design with schema, versioning, and error handling patterns.

Updated Mar 3, 2026
One-click install
npx skills add https://github.com/eniosales08-AI/paraguay-shopping-search --skill api-design-principles-eniosales08-ai
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design-principles
Source: https://github.com/eniosales08-AI/paraguay-shopping-search/tree/main/.cursor/skills/api-design-principles
Command: npx skills add https://github.com/eniosales08-AI/paraguay-shopping-search --skill api-design-principles-eniosales08-ai

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This guide standardizes REST and GraphQL API design to reduce ambiguity and rework, helping teams ship clear, scalable interfaces.

Core Features & Use Cases

  • RESTful and GraphQL design principles for resource modeling, HTTP semantics, and query structure.
  • Versioning strategies, pagination patterns, error handling, and documentation best practices.
  • Use Case: When designing new APIs, reviewing specifications, or establishing team-wide API design standards.

Quick Start

Outline a standard API design plan for REST and GraphQL across your team.

Frequently Asked Questions about api-design-principles

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

FAQPage Schema
What are the best practices for REST and GraphQL API design to ensure long-term maintainability?

Standardizing REST and GraphQL API design involves schema patterns, versioning strategies, error handling, pagination, and documentation to ensure consistency and long-term maintainability across team-wide interfaces.

How do I establish team-wide API design standards for resource modeling and HTTP semantics?

Establishing API design standards requires applying standardized REST and GraphQL principles for resource modeling, HTTP semantics, and query structure to reduce ambiguity and rework when creating new APIs or reviewing specifications.

What versioning strategies and pagination patterns should I use when designing scalable APIs?

Versioning strategies and pagination patterns for scalable APIs are essential design components that prevent breaking changes and manage large datasets, ensuring clear and consistent interfaces for long-term maintainability.

How should error handling be structured in REST and GraphQL APIs to maintain consistency?

Error handling in REST and GraphQL APIs should be standardized alongside schema patterns and versioning strategies to reduce confusion, ensuring consistent interfaces and long-term maintainability across the team.

When do I need to apply standardized API design principles during the development lifecycle?

Standardized API design principles apply when creating new APIs, reviewing specifications, or establishing team-wide design standards to reduce ambiguity and rework, ensuring scalable and clear interfaces.