api-design-principles

Design REST and GraphQL API contracts with typed schemas and consistent status codes.

41|5|Updated Sep 30, 2025
One-click install
npx skills add https://github.com/efekrbas/discord-hypesquad-manager --skill api-design-principles-efekrbas
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design-principles
Source: https://github.com/efekrbas/discord-hypesquad-manager/tree/main/.agents/skills/api-design-principles
Command: npx skills add https://github.com/efekrbas/discord-hypesquad-manager --skill api-design-principles-efekrbas

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill helps you design API contracts that are clear, consistent, scalable, and easy for client developers to adopt without guesswork or rework.

Core Features & Use Cases

  • REST and GraphQL Guidance: Choose the right API style and model resources, queries, mutations, and relationships with strong naming and structure.
  • Production-Ready Standards: Define pagination, filtering, versioning, authentication, authorization, rate limiting, and error responses that behave predictably.
  • Review and Refactor Support: Audit existing APIs for usability issues, inconsistent status codes, weak schema design, or missing documentation.
  • Example Use Case: Use this Skill when planning a new public API or reviewing an existing one before release to ensure it is intuitive, maintainable, and safe to evolve.

Quick Start

Use this skill to review my API design and recommend improvements for resource modeling, versioning, pagination, authentication, and error handling.

Frequently Asked Questions about api-design-principles

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

FAQPage Schema
What is the best way to design REST API pagination and versioning?

The best way to design REST API pagination and versioning is to establish resource-oriented endpoints with typed schemas and consistent status codes. This ensures predictable behavior, reduces client confusion, and allows the API to scale safely over time.

How do I review an existing GraphQL API for schema evolution and usability issues?

To review an existing GraphQL API for schema evolution, audit your queries, mutations, and relationships against production-ready standards. Check for weak schema design, inconsistent structures, and missing documentation to ensure the API is maintainable and intuitive.

How should I handle API error responses and rate limiting for public endpoints?

API error handling and rate limiting should be implemented using robust validation and predictable error responses. Defining consistent status codes and clear error schemas helps client developers adopt the API without guesswork or implementation rework.

When do I need to refactor API contracts to support scalable client adoption?

You need to refactor API contracts to support scalable client adoption when existing designs cause client confusion or implementation rework. Auditing endpoints for inconsistent status codes, weak schema design, and missing documentation resolves these usability issues.

Does this API design guidance apply to both REST and GraphQL planning scenarios?

Yes, this API design guidance applies to both REST and GraphQL planning scenarios. It helps you choose the right API style, model resources, define queries and mutations, and establish production-ready standards for authentication, authorization, and documentation.