api-patterns

Determine REST, GraphQL, or tRPC for API design projects.

1|1|Updated Feb 28, 2025

Search Tags:#versioning #documentation #rest #graphql #patterns #trpc #api-design

Ready to run

npx skills add https://github.com/maskelog/Daegu_bus_flutter_app --skill api-patterns-maskelog

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: api-patterns
Source: https://github.com/maskelog/Daegu_bus_flutter_app/tree/main/.cursor/skills/api-patterns
Command: npx skills add https://github.com/maskelog/Daegu_bus_flutter_app --skill api-patterns-maskelog

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

API design choices across REST, GraphQL, and tRPC create confusion and inconsistency without a clear framework to guide decisions.

Core Features & Use Cases

Provides a decision framework to choose between REST, GraphQL, and tRPC based on project needs and consumer requirements.
Covers versioning strategies, response formats, pagination, and documentation considerations to standardize API design.
Includes a centralized content map and practical guidance for team alignment on API patterns and governance.
Use Case: A multi-platform web/mobile product needing consistent API contracts and a clear pattern selection process for rapid delivery.

Quick Start

Apply the content map and decision tree to your API project to determine the optimal API style.

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?▼

To choose an API design style, apply a decision framework evaluating project needs and consumer requirements. This determines the optimal style between REST, GraphQL, and tRPC to standardize contracts and ensure rapid delivery for web, mobile, or internal services.

What is the best way to standardize API versioning and pagination across multiple platforms?▼

Standardize API versioning and pagination by enforcing governance guidance and documentation standards. A centralized content map provides practical rules for response formats and structure, aligning teams on consistent API patterns across multi-platform web and mobile products.

When do I need a decision tree for API patterns and governance?▼

You need a decision tree for API patterns when API design choices create confusion and inconsistency without a clear framework. It guides decisions on versioning, authentication, and response structure to align teams on governance for rapid delivery.

Does this API design guidance apply to internal service APIs or just public web and mobile apps?▼

This API design guidance applies to internal service APIs as well as web and mobile applications. It evaluates project needs and consumer requirements to determine the suitable API style, enforcing standards for versioning, pagination, and documentation.

How do I implement consistent API contracts and authentication guidance for a new project?▼

Implement consistent API contracts by applying a decision tree and content map to your project. This enforces practical guidance on authentication, versioning, and response structures, providing a clear pattern selection process for team alignment.