Does this skill help with standardized error handling?

Yes, it implements RFC 9457 Problem Details to provide machine-readable, standardized error responses, including field-level validation errors and error catalogs.

Is OpenAPI documentation part of the skill?

Yes, it provides specific rules and patterns for building OpenAPI 3.1 specifications, including schema definitions and documentation best practices.

Can I use this for GraphQL development?

Absolutely. It includes specific patterns for Strawberry code-first schemas, DataLoaders to prevent N+1 issues, and specialized permission and subscription patterns.

What API versioning strategies are supported?

The skill supports multiple strategies including URL path versioning (e.g., /api/v1/), header-based versioning, and provides comprehensive policies for deprecation and sunsetting.

Does it include support for real-time data?

Yes, the skill covers streaming patterns for Server-Sent Events (SSE), WebSockets with heartbeat logic, and gRPC bidirectional streaming.

API Design Patterns & Architecture

Name: API Design Patterns & Architecture
Author: yonatangross

byyonatangross

•

116

•

API開発

Architects production-ready REST, GraphQL, and gRPC APIs using standardized versioning, error handling, and documentation patterns.

This skill provides a comprehensive framework for designing robust and scalable APIs, covering everything from resource modeling and OpenAPI 3.1 specifications to advanced versioning strategies and RFC 9457 compliant error handling. It offers production-ready patterns for backend architects to ensure consistency, backward compatibility, and developer-friendly interfaces across REST, GraphQL, and high-performance gRPC services.

主な機能

01116 GitHub stars

02RFC 9457 'Problem Details' implementation for machine-readable errors

03Standardized REST and GraphQL resource modeling and conventions

04High-performance communication patterns for gRPC, SSE, and WebSockets

05Automated OpenAPI 3.1 specification generation and documentation patterns

06Robust versioning strategies including URL path and header-based methods

ユースケース

01Designing a new public-facing REST API with long-term versioning support

02Implementing a type-safe, code-first GraphQL schema with Strawberry and FastAPI

03Migrating inconsistent error responses to the RFC 9457 Problem Details standard

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