skills.rest
phuonghx
phuonghxCOMMUNITY
Explore all skills by this author →
GitHub

api-patterns

Guide API design decisions for REST, GraphQL, and tRPC.

1|Updated Jun 23, 2026
Search Tags:#security#api design#rest#graphql#trpc
One-click install
npx skills add https://github.com/phuonghx/aim-cli --skill api-patterns-phuonghx
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-patterns
Source: https://github.com/phuonghx/aim-cli/tree/main/aim/templates/aim-agents/skills/api-patterns
Command: npx skills add https://github.com/phuonghx/aim-cli --skill api-patterns-phuonghx

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill unit provides comprehensive guidelines and best practices for designing APIs using REST, GraphQL, and tRPC paradigms, helping developers make informed decisions about API architecture and security.

Core Features & Use Cases

  • API Style Selection: Guidance on choosing the right API style based on the context and requirements.
  • Security Review: Best practices for securing APIs against common vulnerabilities.
  • Documentation: Templates for API documentation that ensure clarity and usability.
  • Use Case: When you need to design a new API or audit an existing one for security and best practices.

Quick Start

Review the 'api-style.md' file to decide whether REST, GraphQL, or tRPC is the best fit for your API.

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

API style selection depends on your project context and requirements. This Skill provides expert guidance to evaluate REST, GraphQL, and tRPC paradigms, ensuring you make informed decisions about your API architecture based on specific use cases.

What are the best practices for securing REST and GraphQL APIs against vulnerabilities?▼

Securing REST and GraphQL APIs requires following specific best practices to prevent common vulnerabilities. This Skill offers expert-level security review guidelines to audit your existing API endpoints and optimize them for robust protection.

How do I document API endpoints for clarity and usability?▼

Document API endpoints using structured templates that ensure clarity and usability. This Skill provides comprehensive documentation guidelines for REST, GraphQL, and tRPC paradigms to help developers understand and consume your API effectively.

Do I need prior knowledge of REST, GraphQL, and tRPC to use this API design guidance?▼

Yes, applying this API design guidance requires existing knowledge of REST, GraphQL, and tRPC paradigms. The Skill delivers expert-level architectural recommendations and security reviews tailored for developers already familiar with these technologies.

When should I audit an existing API for security and performance optimization?▼

You should audit an existing API for security and performance optimization when evaluating architectural robustness. This Skill provides specialized review mechanisms to assess current endpoints against best practices and identify necessary improvements.

Related Skills

Explore More Software Engineering Skills→
HechaoYannetHechaoYannet

create-architecture

Generate a master architecture document from GDDs, ADRs, and governance constraints.

Community
Advanced
belokonmbelokonm
8

api-designer

Design REST and GraphQL APIs and generate OpenAPI 3.1 specifications.

Community
Advanced
ghjghjghkimoghjghjghkimo

api-auditor

Audit API endpoints for security vulnerabilities, OpenAPI conformance, and performance metrics.

Community
Basic
Kirankumar2604Kirankumar2604

pnpm-workspace

Standardize TypeScript monorepos with pnpm workspaces and strict project references.

Community
Advanced