skills.rest
figuedmundo
figuedmundoCOMMUNITY
Explore all skills by this author →
GitHub

api-design-principles

Provides guidance for designing RESTful and GraphQL APIs.

Updated Jan 6, 2026
Search Tags:#api design#rest#developer experience#graphql#api standards#api patterns
One-click install
npx skills add https://github.com/figuedmundo/mamirri-app --skill api-design-principles-figuedmundo
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design-principles
Source: https://github.com/figuedmundo/mamirri-app/tree/main/.agents/skills/api-design-principles
Command: npx skills add https://github.com/figuedmundo/mamirri-app --skill api-design-principles-figuedmundo

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill helps developers and architects design and refine RESTful and GraphQL APIs, ensuring they are intuitive, scalable, and maintainable.

Core Features & Use Cases

  • API Design Guidance: Provides principles and patterns for both REST and GraphQL.
  • Best Practices: Covers resource naming, HTTP methods, status codes, versioning, error handling, and more.
  • Use Case: When starting a new microservice with a REST API, consult this Skill to ensure the endpoints are designed according to best practices, making them easy for consumers to understand and use.

Quick Start

Review the RESTful design principles for creating resource-oriented endpoints.

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 a scalable REST API?▼

REST API design principles focus on resource-oriented architecture, correct HTTP method semantics, standard status codes, and consistent naming to build intuitive and scalable endpoints.

How do I prevent the N+1 problem when building a GraphQL API?▼

Preventing the N+1 problem in GraphQL API design involves applying specific schema design patterns and data fetching strategies to efficiently resolve nested queries without overloading the database.

What is the best way to handle API versioning and error handling?▼

The best way to handle API versioning and error handling is to apply standardized API patterns that ensure maintainability, providing clear error schemas and versioning strategies for consumers.

Should I choose REST or GraphQL for my new microservice API?▼

Choosing between REST and GraphQL depends on your developer experience goals; REST offers resource-oriented architecture while GraphQL provides flexible schema design, and this guidance covers best practices for both.

How do I structure endpoints for a resource-oriented API?▼

Structuring endpoints for a resource-oriented API requires following RESTful design principles that map HTTP methods to resource nouns, ensuring the API is intuitive and easy for consumers to use.

Related Skills

Explore More Software Engineering Skills→
takemo101takemo101

basic-design-writer

Generate foundational system design documents in Japanese with Mermaid diagrams.

Community
Intermediate
ginkidaginkida
20

openapi-expert

Design, validate, and generate code from OpenAPI 3.x specifications.

Community
Advanced
act70255act70255

api-documenter

Generate SDKs and interactive developer portals from OpenAPI 3.1 specifications.

Community
Advanced
camilooscargbaptistacamilooscargbaptista
7

api-gateway-patterns

Design API gateway architectures with rate limiting, authentication, routing, and circuit breaking.

Community
Intermediate