api-design-principles

Define and enforce REST and GraphQL API design standards across teams.

Updated Apr 19, 2026
One-click install
npx skills add https://github.com/ArogyaReddy/https-github.com-wshobson-agents --skill api-design-principles-arogyareddy
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design-principles
Source: https://github.com/ArogyaReddy/https-github.com-wshobson-agents/tree/main/plugins/backend-development/skills/api-design-principles
Command: npx skills add https://github.com/ArogyaReddy/https-github.com-wshobson-agents --skill api-design-principles-arogyareddy

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This guide provides proven principles for designing robust REST and GraphQL APIs, helping teams avoid common pitfalls and build developer-friendly interfaces.

Core Features & Use Cases

  • Schema-first design for GraphQL and resource-oriented REST design to ensure consistent abstractions.
  • Versioning, pagination, error handling, and documentation patterns to support scalable APIs across teams.
  • Use Case: Migrate an existing REST service to GraphQL with minimal client impact and improved developer experience.

Quick Start

Apply these principles to a new API project by outlining resources, endpoints, versioning strategy, and error schemas.

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?

REST and GraphQL API design best practices involve schema-first design, resource-oriented abstractions, consistent versioning, pagination, error handling, and documentation patterns to ensure scalable and maintainable interfaces across teams.

How do I migrate an existing REST service to GraphQL?

Migrate an existing REST service to GraphQL by applying schema-first design principles to map resources to a unified graph, minimizing client impact while improving developer experience through consistent abstractions and scalable patterns.

How should I handle API versioning and pagination standards across teams?

Handle API versioning and pagination standards by applying reusable design templates that enforce consistent schemas, error handling, and documentation patterns across development teams for maintainable API endpoints.

When should I choose GraphQL over REST for my API architecture?

Choose GraphQL over REST when you need schema-first design flexibility and minimal client impact during migrations, whereas resource-oriented REST design ensures consistent abstractions for simpler endpoint interactions.

What patterns should I use for consistent API error handling and documentation?

Use reusable design templates for API error handling and documentation to define consistent error schemas and standardized patterns, ensuring developer-friendly interfaces and scalable API maintenance across teams.