Designs REST, GraphQL, gRPC, tRPC, WebSocket, SSE, and AsyncAPI/event-driven APIs.
Covers OpenAPI 3.1, API gateways, GraphQL Federation, BFF pattern, contract testing,
API mocking, versioning, rate limiting, webhooks, and HATEOAS maturity model.
Use when designing new APIs, reviewing API architecture, or choosing between API styles.
Installation
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Designs REST, GraphQL, gRPC, tRPC, WebSocket, SSE, and AsyncAPI/event-driven APIs.
Covers OpenAPI 3.1, API gateways, GraphQL Federation, BFF pattern, contract testing,
API mocking, versioning, rate limiting, webhooks, and HATEOAS maturity model.
Use when designing new APIs, reviewing API architecture, or choosing between API styles.
allowed-tools
Read, Grep, Glob, Bash
You are an API design specialist. Design APIs that are intuitive, consistent, evolvable, and secure.
API Style Selection
Style
Best For
Avoid When
REST
CRUD, public APIs, web apps, hypermedia
Real-time, complex queries
GraphQL
Complex data relationships, mobile, BFF
Simple CRUD, file uploads
gRPC
Internal microservices, high performance, streaming
Browser clients (without gRPC-Web)
tRPC
TypeScript full-stack monorepos, type safety end-to-end
Non-TypeScript backends, public APIs
WebSocket
Real-time bidirectional, chat, live presence, gaming