skills.rest
Ayub-Khan
Ayub-KhanCOMMUNITY
Explore all skills by this author →
GitHub

api-design

Design REST, GraphQL, gRPC, and WebSocket APIs with resource modeling and versioning.

Updated Apr 23, 2026
Search Tags:#documentation#api#rest#graphql#websocket#grpc#api-design
One-click install
npx skills add https://github.com/Ayub-Khan/immortal_agent_swarm --skill api-design-ayub-khan
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/Ayub-Khan/immortal_agent_swarm/tree/main/.agents/skills/api-design
Command: npx skills add https://github.com/Ayub-Khan/immortal_agent_swarm --skill api-design-ayub-khan

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

API design across REST, GraphQL, gRPC, and WebSockets can be complex and error-prone; this skill provides structured guidance for resource modeling, versioning strategies, authentication patterns, rate limiting, and documentation standards.

Core Features & Use Cases

  • Resource modeling best practices for REST, GraphQL schemas, and gRPC services.
  • Versioning and lifecycle management across API versions.
  • Security and documentation patterns including authentication, rate limiting, and OpenAPI/GraphQL documentation.
  • Use Case: When designing a new service, apply this skill to produce a consistent API design spec and docs.

Quick Start

Generate a complete API design blueprint for a new user service across REST and GraphQL.

Frequently Asked Questions about api-design

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

FAQPage Schema
How do I design a scalable API with proper resource modeling and versioning?▼

To design a scalable API, apply structured guidance for resource modeling, versioning strategies, and lifecycle management. This ensures consistent API design specs across REST, GraphQL, gRPC, and WebSocket protocols.

What is the best way to structure authentication and rate limiting for web services?▼

Structuring authentication and rate limiting requires applying standardized security patterns across your web services. This enforces best practices for API security, protecting resources across REST, GraphQL, gRPC, and WebSockets.

How do I generate API documentation for GraphQL and REST endpoints?▼

Generating API documentation involves applying documentation standards like OpenAPI for REST and schema definitions for GraphQL. This produces clear, standardized docs that enforce best practices across your web services.

When do I need gRPC or WebSockets instead of REST for my API design?▼

You need gRPC or WebSockets instead of REST when your API design requires specific communication patterns like real-time streaming or high-performance RPC. Apply structured guidance to choose the right protocol for your service.

Can I use one consistent API design spec for a service across both REST and GraphQL?▼

Yes, you can produce a single consistent API design blueprint for a service across both REST and GraphQL. This is achieved by applying unified resource modeling, versioning, and security best practices.

What are the limitations of applying a single API design pattern across different protocols?▼

Applying a single API design pattern across protocols requires adapting resource modeling and security to each format's constraints. You must adjust implementation details for REST, GraphQL, gRPC, and WebSockets respectively.

Related Skills

Explore More Software Engineering Skills→
HechaoYannetHechaoYannet

create-architecture

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

Community
Advanced
skaile-aiskaile-ai

use-mcp2cli

Convert MCP servers, OpenAPI, and GraphQL schemas into runnable CLI commands.

Official
Intermediate
vertivolatamvertivolatam
1

API Gateway & Rate Limiting

Implement API Gateways with Kong and Nginx rate limiting strategies.

Official
Advanced
ginkidaginkida
20

openapi-expert

Design, validate, and generate code from OpenAPI 3.x specifications.

Community
Advanced