api-patterns

Design and validate REST, GraphQL, and tRPC APIs against best practices.

Updated Mar 11, 2026
One-click install
npx skills add https://github.com/act70255/SkillsBundle --skill api-patterns-act70255
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-patterns
Source: https://github.com/act70255/SkillsBundle/tree/main/dev-python/skills/api-patterns
Command: npx skills add https://github.com/act70255/SkillsBundle --skill api-patterns-act70255

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill unit provides expert guidance on API design principles, helping you make informed decisions for REST, GraphQL, and tRPC API styles, and ensuring your APIs are robust, secure, and efficient.

Core Features & Use Cases

  • API Style Decision Making: Offers a decision tree for choosing the right API style based on consumer needs and context.
  • API Design Principles: Detailed guidance on REST, GraphQL, and tRPC, including schema design, versioning, and security.
  • Use Cases: Ideal for developers, architects, and product managers who need to design, update, or optimize their APIs.

Quick Start

Run the 'api_validator.py' script in the 'scripts/' directory to validate your API against best practices.

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?

Choosing between REST, GraphQL, and tRPC requires evaluating your consumer needs and context. This Skill provides a decision tree to help you select the right API style based on your specific architecture requirements.

What are the best practices for API versioning and security?

Best practices for API versioning and security involve applying specific design principles to your chosen architecture. This Skill provides detailed guidance on implementing robust security and versioning strategies for REST, GraphQL, and tRPC APIs.

How do I validate my API against modern design principles?

You can validate your API against modern design principles by running the provided `api_validator.py` script. This script checks your API implementation to ensure it aligns with established best practices and robust schema design.

Does this API design guidance apply to maintaining existing APIs?

Yes, this API design guidance applies to maintaining existing APIs. It is ideal for developers and architects who need to update, optimize, and validate their current REST, GraphQL, or tRPC implementations against expert principles.

When should I not use REST for my API architecture?

You should consider alternatives to REST when your consumers face over-fetching or under-fetching issues. This Skill helps determine when GraphQL or tRPC is a better fit for your specific data retrieval and architectural needs.