api-design-principles

Define and enforce scalable REST and GraphQL API design patterns.

2|7|Updated Feb 22, 2026
One-click install
npx skills add https://github.com/chidekina/aria-superpowers --skill api-design-principles-chidekina
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design-principles
Source: https://github.com/chidekina/aria-superpowers/tree/main/skills/api-design-principles
Command: npx skills add https://github.com/chidekina/aria-superpowers --skill api-design-principles-chidekina

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

REST and GraphQL API design is inconsistent, creating hard-to-use interfaces and brittle integrations.

Core Features & Use Cases

  • Schema-first REST and GraphQL principles, versioning strategies, pagination, and error handling patterns.
  • Patterns for resource design, traversal, and data loading to minimize over- and under-fetching.
  • Use cases including designing new APIs, auditing existing specs, and establishing team-wide standards.

Quick Start

Review a REST or GraphQL API draft and apply the standard patterns.

Frequently Asked Questions about api-design-principles

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

FAQPage Schema
How do I standardize REST and GraphQL API design patterns across my team?

Standardize REST and GraphQL API design by applying a schema-first approach with documented best practices. This enforces consistent resource modeling, pagination, versioning, and error handling patterns across both REST and GraphQL scenarios to prevent brittle integrations.

What is the best way to handle API versioning and pagination in GraphQL and REST?

Handle API versioning and pagination by applying standard design patterns using a schema-first approach. This ensures consistent data-loading patterns and minimizes over-fetching and under-fetching across both REST and GraphQL APIs.

How do I audit existing API specifications for consistency and best practices?

Audit existing API specifications by reviewing the REST or GraphQL draft against standard patterns. This process identifies inconsistencies in resource design, traversal, and error handling to establish team-wide standards for scalable interfaces.

Can I use this to minimize data over-fetching and under-fetching in GraphQL?

Yes, you can minimize data over-fetching and under-fetching by applying specific resource design and data-loading patterns. These patterns optimize traversal and data retrieval across GraphQL scenarios for more efficient interfaces.

Why does inconsistent REST API design create hard-to-use interfaces?

Inconsistent REST API design creates hard-to-use interfaces because it lacks standardized resource modeling and error handling. Without schema-first principles and documented best practices, integrations become brittle and difficult to maintain across team-wide implementations.