Can I use this for real-time applications?

Absolutely. The skill provides best-practice patterns for Server-Sent Events (SSE) and bidirectional WebSockets, including heartbeat, reconnection logic, and proper resource cleanup.

What error handling standard does it use?

It implements the RFC 9457 'Problem Details for HTTP APIs' standard, providing machine-readable error responses using the application/problem+json content type.

Does this skill support OpenAPI documentation?

Yes, it includes rules for generating and maintaining OpenAPI 3.1 specifications to ensure your API remains well-documented and compatible with client generators.

Does it help with API versioning?

Yes, it provides specific strategies for URL path versioning (e.g., /api/v1/), header-based versioning, and formal deprecation/sunset policies to prevent breaking client integrations.

Is GraphQL supported?

Yes, it features comprehensive patterns for Strawberry GraphQL, including code-first schemas, DataLoaders for N+1 prevention, and permission-based access control.

API Design & Architecture

Name: API Design & Architecture
Author: yonatangross

byyonatangross

•

116

•

API開発

Implements production-ready API patterns for REST, GraphQL, and gRPC with standardized versioning and RFC 9457 error handling.

This skill provides a comprehensive toolkit for designing robust, scalable, and developer-friendly APIs within the Claude Code environment. It encompasses standardized REST conventions, type-safe GraphQL schemas using Strawberry, high-performance gRPC service definitions, and real-time streaming patterns via SSE or WebSockets. By enforcing RFC 9457 Problem Details for error handling and providing structured versioning strategies, it ensures that backend systems remain maintainable and backward-compatible while providing clear, machine-readable feedback to clients. It is ideal for architects and backend developers building production-grade services that require strict contract enforcement and professional documentation.

主な機能

01Type-safe GraphQL schema design with Strawberry integration

02Real-time data streaming patterns for SSE and WebSockets

03RFC 9457 compliant 'Problem Details' error handling

04116 GitHub stars

05Standardized REST and GraphQL architectural patterns

06Robust API versioning and deprecation strategies

ユースケース

01Designing a new RESTful API with consistent resource modeling and OpenAPI 3.1 specifications.

02Implementing standardized machine-readable error responses across microservices using RFC 9457.

03Managing API lifecycles with URL-based versioning and automated deprecation headers.

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add yonatangross/orchestkit api-design

For use in Claude.ai and ChatGPT

Download Skill