Does it cover real-time protocols?

Absolutely. The skill includes design patterns for both WebSockets and Server-Sent Events (SSE) to handle real-time data streaming.

What security practices are included?

The skill guides you through implementing Bearer tokens, API keys, rate limiting (X-RateLimit headers), CORS whitelisting, and input validation using schemas like Zod or Joi.

Does this skill support OpenAPI documentation?

Yes, the skill includes specialized patterns for writing and maintaining OpenAPI 3.0 specifications, ensuring your API is well-documented and machine-readable.

How does it handle API versioning?

It provides multiple strategies for versioning, including URL path, custom headers, and query parameters, along with formal deprecation and sunset protocols.

Can it help with GraphQL performance?

Yes, it specifically addresses common issues like the N+1 problem by providing resolver patterns that utilize DataLoaders and efficient batching.

API Design & Architecture

Name: API Design & Architecture
Author: miles990

bymiles990

•

API 개발

Architects robust, scalable, and intuitive APIs using REST, GraphQL, and gRPC industry best practices.

소개

This skill empowers Claude with specialized knowledge for designing modern web interfaces that are consistent, performant, and developer-friendly. It provides comprehensive patterns for resource naming, pagination, and error handling across multiple protocols including REST, GraphQL, and gRPC. Beyond basic endpoint design, it addresses advanced architectural concerns such as versioning strategies, real-time communication via WebSockets/SSE, and the creation of machine-readable OpenAPI documentation. It also includes critical 'Sharp Edge' detection to prevent common pitfalls like breaking changes, N+1 query problems, and security vulnerabilities like missing rate limits.

주요 기능

Comprehensive versioning and sunset/deprecation strategies
Standardized resource naming and HTTP status code mapping
Real-time data streaming patterns using SSE and WebSockets
Multi-protocol design patterns for REST, GraphQL, gRPC, and WebSockets
1 GitHub stars
Automated OpenAPI (Swagger) schema generation and best practices

사용 사례

Defining a consistent resource-oriented REST API for a public-facing developer platform
Architecting high-performance microservice communication using gRPC and Protocol Buffers
Building flexible GraphQL schemas with optimized resolvers and N+1 prevention

소개

주요 기능

Comprehensive versioning and sunset/deprecation strategies
Standardized resource naming and HTTP status code mapping
Real-time data streaming patterns using SSE and WebSockets
Multi-protocol design patterns for REST, GraphQL, gRPC, and WebSockets
1 GitHub stars
Automated OpenAPI (Swagger) schema generation and best practices

사용 사례

Defining a consistent resource-oriented REST API for a public-facing developer platform
Architecting high-performance microservice communication using gRPC and Protocol Buffers
Building flexible GraphQL schemas with optimized resolvers and N+1 prevention