api-design-principles

Enforce standardized design principles for REST and GraphQL APIs.

1|Updated Dec 23, 2025

Search Tags:#design #versioning #GraphQL #REST #APIs #error-handling #pagination

Ready to run

npx skills add https://github.com/ccf/claude-code-ccf-marketplace --skill api-design-principles-ccf

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: api-design-principles
Source: https://github.com/ccf/claude-code-ccf-marketplace/tree/main/plugins/backend-development/skills/api-design-principles
Command: npx skills add https://github.com/ccf/claude-code-ccf-marketplace --skill api-design-principles-ccf

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This skill standardizes REST and GraphQL API design to eliminate inconsistency, improve developer experience, and reduce maintenance costs.

Core Features & Use Cases

Schema-first design principles for REST and GraphQL
Versioning strategies (URL, header, query parameter)
Error handling, pagination, and client-friendly responses
API documentation and governance guidance
Use Case: A team migrating from REST to GraphQL uses this to plan schema, resolvers, and migration steps

Quick Start

Design a REST API for a product catalog following REST best practices and draft a GraphQL schema for product and category queries.

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?▼

Standardized API design uses schema-first principles, consistent resource naming, versioning strategies, error handling, and pagination. This eliminates inconsistency and improves developer experience across REST and GraphQL governance tasks.

How do I plan a migration from REST to GraphQL?▼

Plan a REST to GraphQL migration by applying schema-first design principles to draft GraphQL schemas, plan resolvers, and define structured migration steps while maintaining consistent API governance and documentation guidelines.

Which API versioning strategy should I use for my endpoints?▼

API versioning strategies include URL path, header, and query parameter approaches. Choosing the right versioning strategy ensures consistent resource naming and robust API governance without breaking existing client integrations.

How should error handling and pagination be structured in APIs?▼

Error handling and pagination in APIs should be structured to provide client-friendly responses. Standardized patterns ensure robust API documentation and governance, allowing clients to reliably process errors and navigate large datasets.

Does schema-first design work for both REST and GraphQL?▼

Schema-first design works for both REST and GraphQL APIs. It enforces standardized design principles and consistent resource naming, ensuring robust documentation guidelines and reducing maintenance costs across diverse API patterns.