api-patterns

Guide architects in selecting REST, GraphQL, or tRPC for projects.

Updated Dec 10, 2024
One-click install
npx skills add https://github.com/melikhanmutlu/web_ar --skill api-patterns-melikhanmutlu
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-patterns
Source: https://github.com/melikhanmutlu/web_ar/tree/main/.agent/skills/api-patterns
Command: npx skills add https://github.com/melikhanmutlu/web_ar --skill api-patterns-melikhanmutlu

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

API design and technology decision-making can be challenging; this Skill provides a structured approach to choosing between REST, GraphQL, and tRPC based on project context, data needs, and team constraints.

Core Features & Use Cases

  • Decision framework for selecting the most appropriate API style (REST, GraphQL, or tRPC) for a given scenario
  • Practical guidance on versioning, response formats, and authentication considerations
  • Reference patterns and checklists to prevent common anti-patterns in API design
  • Real-world use cases focused on multi-platform products, monorepos, and evolving data requirements

Quick Start

Assess your API consumers and data needs, then choose REST, GraphQL, or tRPC using the decision criteria provided.

Frequently Asked Questions about api-patterns

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

FAQPage Schema
How do I choose between REST, GraphQL, and tRPC for my API design?

Selecting an API style requires evaluating project context, data needs, and team constraints. This framework provides explicit decision criteria to help architects balance REST, GraphQL, and tRPC for multi-platform products and evolving data requirements.

What is the best way to manage API versioning and security across multiple platforms?

Managing API versioning and security requires practical guidance on response formats and authentication considerations. The framework provides reference patterns and checklists to prevent common anti-patterns while supporting consistent API design across multi-platform products.

How do I design an API for a monorepo with evolving data requirements?

Designing an API for a monorepo with evolving data requirements involves balancing flexibility and consistency. The framework provides real-world use cases and decision criteria focused on monorepos to help you select the right API style and prevent common design anti-patterns.

Does this API decision framework support teams with evolving data needs?

Yes, the API decision framework explicitly supports teams with evolving data needs. It provides a structured approach to balance REST, GraphQL, and tRPC options, ensuring your API style adapts to changing data requirements and multi-platform product constraints.

What are common API design anti-patterns and how can I prevent them?

Common API design anti-patterns involve inconsistent versioning, poor response formats, and weak authentication. The framework provides reference patterns and checklists to prevent these anti-patterns, ensuring consistent API design and documentation across your project.