api-design-principles

Standardize REST and GraphQL API design decisions across specifications.

6|Updated Mar 1, 2026
One-click install
npx skills add https://github.com/ChrstprJohn/SamsonDentalCenter --skill api-design-principles-chrstprjohn
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design-principles
Source: https://github.com/ChrstprJohn/SamsonDentalCenter/tree/main/.agent/skills/Backend/api-design-principles
Command: npx skills add https://github.com/ChrstprJohn/SamsonDentalCenter --skill api-design-principles-chrstprjohn

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

Organizations often design REST and GraphQL APIs in silos, leading to inconsistent contracts, poor developer experience, and onboarding friction across teams.

Core Features & Use Cases

  • Establishes a standardized approach to API design across REST and GraphQL, including naming, contracts, and consistency checks.
  • Guides decision-making on API style, resource modeling, error handling, versioning, pagination, and authentication.
  • Useful for designing new APIs, evaluating specifications, or enforcing team-wide design standards.

Quick Start

Define a standard API design for a new project using REST and GraphQL by outlining resources, errors, versioning, and pagination.

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 standardizing resource modeling, error handling, versioning, pagination, and authentication to establish consistent contracts and improve developer experience across teams.

How do I standardize API design across REST and GraphQL for my team?

Standardize API design by defining consumers, use cases, and constraints, then applying consistent rules for resource modeling, error specifications, versioning, pagination, and authentication across both REST and GraphQL endpoints.

Should I use REST or GraphQL for my new API project?

Choosing between REST and GraphQL requires defining your consumers, use cases, and constraints to select the API style and resource model that best fits your project's specific requirements.

How do I structure error handling, versioning, and pagination in API specifications?

Structure error handling, versioning, and pagination by applying standardized design decisions that define error formats, versioning strategies, and pagination methods, validating them with concrete examples.

Can I review existing API specifications using these design standards?

Yes, you can review existing API specifications by evaluating their resource models, error handling, versioning, pagination, and authentication against established REST and GraphQL design standards to ensure consistency.