api-design-principles

Guide RESTful and GraphQL API design with versioning and error handling principles.

Updated Dec 22, 2025

Search Tags:#api design #rest #developer experience #graphql #software architecture #api standards

Ready to run

npx skills add https://github.com/fuziix266/mavoo-laminas --skill api-design-principles-fuziix266

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: api-design-principles
Source: https://github.com/fuziix266/mavoo-laminas/tree/main/instrucciones/.agents/skills/api-design-principles
Command: npx skills add https://github.com/fuziix266/mavoo-laminas --skill api-design-principles-fuziix266

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill helps developers and architects design, review, and standardize intuitive, scalable, and maintainable REST and GraphQL APIs.

Core Features & Use Cases

API Design Guidance: Provides principles and patterns for both RESTful and GraphQL API development.
Best Practices & Pitfalls: Highlights common mistakes and offers solutions for robust API design.
Use Case: When starting a new microservice, use this Skill to ensure the API adheres to best practices for resource naming, HTTP methods, and error handling, ensuring consistency across your architecture.

Quick Start

Use the api-design-principles skill to get guidance on designing a new REST API endpoint for user management.

Frequently Asked Questions about api-design-principles

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

FAQPage Schema

What are the core principles for designing scalable REST and GraphQL APIs?▼

Core REST and GraphQL API design principles emphasize intuitive resource naming, standard HTTP methods, and robust error handling to ensure scalable and maintainable software architecture.

How do I handle versioning and errors when building a RESTful API?▼

To handle versioning and errors in a RESTful API, apply established versioning strategies and standardized error handling patterns to prevent common pitfalls and maintain architectural consistency.

What is the best way to standardize API design across new microservices?▼

The best way to standardize API design across microservices is to enforce consistent resource naming, HTTP methods, and error handling best practices during the initial development phase.

When should I choose GraphQL over REST for my software architecture?▼

Choose GraphQL over REST when your API design requires flexible client-driven data fetching, contrasting with REST's standardized resource endpoints, to optimize developer experience.

What are common API design pitfalls and how can I avoid them?▼

Common API design pitfalls include inconsistent resource naming and poor error handling, which you can avoid by applying documented best practices for REST and GraphQL development.