api-patterns

Determine the optimal API style for a given project context.

1|Updated Dec 28, 2025
One-click install
npx skills add https://github.com/barbosakjn/finance-app --skill api-patterns-barbosakjn
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-patterns
Source: https://github.com/barbosakjn/finance-app/tree/main/.agent/workflows/.agent/skills/api-patterns
Command: npx skills add https://github.com/barbosakjn/finance-app --skill api-patterns-barbosakjn

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

api-patterns helps engineering teams decide the most suitable API style (REST, GraphQL, or tRPC) for a project, balancing trade-offs between simplicity, flexibility, and long-term maintainability.

Core Features & Use Cases

  • Decision framework for selecting API styles based on context (consumers, data requirements, and deployment model)
  • Guidelines for REST, GraphQL, and tRPC design considerations, including versioning, error handling, and documentation
  • Real-world use cases across monorepos, public APIs, and internal tooling

Quick Start

Request a recommended API style for your project context from the guidance.

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 backend API?

Choosing between REST, GraphQL, and tRPC involves evaluating your project's consumers, data needs, versioning, authentication, performance, and maintainability to balance trade-offs between flexibility and simplicity.

What is the best way to design API versioning for internal microservices?

The best way to design API versioning for internal microservices depends on your deployment model and API style, weighing long-term maintainability against the data requirements of your specific consumers.

When should I use tRPC instead of REST in a monorepo?

You should use tRPC instead of REST in a monorepo when your project prioritizes end-to-end type safety and internal tooling simplicity over the broad flexibility required for public API consumers.

Does GraphQL work well for public APIs with diverse consumer data needs?

GraphQL works well for public APIs with diverse consumer data needs because it allows clients to query exactly the data they require, reducing over-fetching and improving flexibility across varied use cases.

What factors should I consider for API design decision-making across different deployment models?

For API design decision-making across deployment models, consider your consumers, data requirements, versioning strategy, authentication, performance constraints, and maintainability to determine the optimal API style.