api-patterns

Helps choose between REST, GraphQL, and Mintlify based on your needs.

98|25|Updated Mar 14, 2020
One-click install
npx skills add https://github.com/baotoq/micro-commerce --skill api-patterns-baotoq
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-patterns
Source: https://github.com/baotoq/micro-commerce/tree/main/.agents/skills/api-patterns
Command: npx skills add https://github.com/baotoq/micro-commerce --skill api-patterns-baotoq

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Guides teams through API-pattern decisions to harmonize REST, GraphQL, and tRPC choices across services, reducing misalignment and rework.

Core Features & Use Cases

  • Comprehensive decision framework for API styles, versioning, pagination, and error formats.
  • Reusable guidance for architecture reviews, platform decisions, and governance.
  • Real-world examples and anti-patterns to avoid common pitfalls.

Quick Start

Ask the AI to pick an API style (REST, GraphQL, or tRPC) for your project and justify the choice with concrete examples.

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 microservices architecture?

Choosing between REST, GraphQL, and tRPC requires evaluating your API patterns against decision criteria for versioning, responses, and security. This framework provides concrete examples and anti-patterns to justify the correct API style for your architecture.

What is the best way to standardize API versioning and error formats across services?

Standardizing API versioning and error formats requires a comprehensive decision framework that enforces evaluation of code patterns and documentation standards. It provides reusable governance guidance to harmonize responses and avoid common pitfalls across services.

Can I use this API design framework for architecture reviews and platform governance?

Yes, this API design framework provides reusable guidance specifically for architecture reviews and platform decisions. It enforces validation checks via included scripts to ensure consistency and governance across your microservices.

Does this framework validate API consistency and documentation standards automatically?

Yes, the framework enforces evaluation of code patterns and documentation standards via included scripts, such as an API validator. These validation checks ensure consistency and governance across your chosen REST, GraphQL, or tRPC implementations.

When should I avoid using tRPC or GraphQL in favor of REST?

You should evaluate API styles based on specific decision criteria for versioning, responses, and security rather than defaulting to one approach. The framework outlines real-world anti-patterns to help you recognize when REST is more appropriate than GraphQL or tRPC.