skills.rest
rnavarych
rnavarychCOMMUNITY
Explore all skills by this author →
GitHub

api-design

Guide API design across REST, GraphQL, and gRPC protocols.

14|3|Updated Feb 22, 2026
Search Tags:#architecture#best practices#api design#rest#graphql#grpc
One-click install
npx skills add https://github.com/rnavarych/alpha-engineer --skill api-design-rnavarych
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/rnavarych/alpha-engineer/tree/main/plugins/billy-milligan/skills/architecture/api-design
Command: npx skills add https://github.com/rnavarych/alpha-engineer --skill api-design-rnavarych

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill provides guidance and patterns for designing robust, scalable, and maintainable APIs across various protocols like REST, GraphQL, and gRPC.

Core Features & Use Cases

  • API Design Patterns: Learn best practices for naming, pagination, error handling, versioning, and more.
  • Protocol Specifics: Get insights into GraphQL schema design, gRPC streaming, and RESTful resource management.
  • Use Case: When starting a new microservice, use this Skill to ensure your API adheres to industry best practices for consistency and future maintainability.

Quick Start

Use the api-design skill to learn about REST API naming conventions.

Frequently Asked Questions about api-design

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
What are the best practices for REST API resource naming and pagination?▼

REST API design best practices cover resource naming conventions, cursor-based pagination, structured error responses, API versioning, idempotency keys, and rate limiting to create maintainable microservice endpoints.

How do I design a GraphQL schema with structured error responses?▼

GraphQL schema design involves protocol-specific insights for structuring robust error responses and maintainable types. This guidance facilitates creating well-architected API services by covering essential patterns for scalable implementations.

When should I use gRPC streaming versus REST for my microservice API?▼

Use gRPC streaming when your microservice needs robust streaming capabilities, while REST suits standard resource management. This guidance provides protocol-specific insights for both gRPC and REST to ensure your API adheres to industry best practices.

How do I implement idempotency keys and rate limiting in API design?▼

API design patterns for idempotency keys and rate limiting ensure robust, scalable services by preventing duplicate operations and managing traffic. Applying these essential patterns facilitates well-architected and maintainable API endpoints.

What is the best way to handle API versioning strategies for maintainability?▼

API versioning strategies ensure future maintainability and consistency by structuring endpoint changes systematically. This guidance covers essential versioning patterns alongside resource naming, error handling, and idempotency to create well-architected services.

Related Skills

Explore More Software Engineering Skills→
HechaoYannetHechaoYannet

create-architecture

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

Community
Advanced
thesaifalitaithesaifalitai
8

api-designer

Design REST and GraphQL API architectures and generate OpenAPI 3.1 specifications.

Community
Advanced
cenjiecenjie

api-security-hardening

Secure REST APIs with authentication, rate limiting, CORS, and input validation.

Community
Advanced
htayjhtayj

add-rest-endpoint

Automate REST API endpoint creation with schema design, routing, handlers, tests, and documentation.

Community
Intermediate