skills.rest
itsimonfredlingjack
itsimonfredlingjackCOMMUNITY
Explore all skills by this author →
GitHub

api-design-patterns

Guides API design patterns for REST, GraphQL, and gRPC with versioning, authentication, pagination, and error handling.

Updated Feb 14, 2026
Search Tags:#architecture#api#design patterns#rest#graphql#grpc
One-click install
npx skills add https://github.com/itsimonfredlingjack/ELECTRON-prompt-builder --skill api-design-patterns-itsimonfredlingjack
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design-patterns
Source: https://github.com/itsimonfredlingjack/ELECTRON-prompt-builder/tree/main/.cursor/skills/api-design-patterns
Command: npx skills add https://github.com/itsimonfredlingjack/ELECTRON-prompt-builder --skill api-design-patterns-itsimonfredlingjack

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides comprehensive guidance on designing, implementing, and optimizing APIs, ensuring robustness, scalability, and developer experience across various architectural styles.

Core Features & Use Cases

  • API Style Selection: Guidance on choosing between REST, GraphQL, and gRPC based on project needs.
  • Pattern Implementation: Detailed patterns for versioning, authentication, pagination, error handling, and caching.
  • Use Case: A backend engineer needs to design a new microservice API. They can consult this Skill to understand the trade-offs between gRPC for internal communication and REST for external clients, and implement best practices for authentication and versioning.

Quick Start

Review the core principles for designing consistent and secure APIs.

Frequently Asked Questions about api-design-patterns

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

FAQPage Schema
How do I choose between REST, GraphQL, and gRPC for my API architecture?▼

API style selection depends on project needs: use REST for external clients, GraphQL for flexible queries, or gRPC for internal microservice communication. This Skill details these architectural trade-offs to guide your design choice.

What are the best practices for API versioning, pagination, and error handling?▼

Best practices for API versioning, pagination, and error handling involve implementing consistent patterns across your endpoints. This Skill provides detailed explanations and code examples to ensure robust and maintainable API design.

How does API authentication and caching work for scalable microservices?▼

API authentication and caching for scalable microservices work by applying specific design patterns that secure endpoints and optimize response times. This Skill covers these patterns to facilitate robust, scalable, and maintainable API architectures.

What are common API anti-patterns I should avoid during design?▼

Common API anti-patterns to avoid include inconsistent versioning, poor error handling, and inadequate security measures. This Skill highlights these anti-patterns alongside best practices to help you build robust APIs.

When should I use gRPC over REST for backend communication?▼

You should use gRPC over REST for internal backend communication where low latency and high throughput are critical, while REST suits external clients. This Skill explains architectural trade-offs to determine the right fit.

Related Skills

Explore More Software Engineering Skills→
balic-AI-ML-R-D-Resourcesbalic-AI-ML-R-D-Resources

security-audit-context-building

Map architecture, trust boundaries, and data flows for security audit scoping.

Official
Advanced
vikisingh23vikisingh23
4

api-testing

Generate and validate Postman/Newman test collections from OpenAPI/Swagger specs.

Community
Intermediate
erichowenserichowens
181

api-architect

Design and validate REST, GraphQL, and gRPC API contracts and architectures.

Community
Advanced
krzysztofsurdykrzysztofsurdy
20

backend-dev

Implements backend services, APIs, and data models for software applications.

Community
Advanced