api-design-framework

REST API design requires versioning strategies, standardized error handling conventions, and backward compatibility patterns. This Skill provides templates and enforced conventions for consistent REST endpoints, version management, and error responses across services.

OpenAPI specifications standardize API documentation and enable code generation. This Skill provides OpenAPI templates and conventions to create well-documented REST interfaces with consistent schema definitions and endpoint descriptions.

This Skill covers REST, GraphQL, and gRPC API design. It provides templates, conventions, and authentication approaches for all three protocols, ensuring consistency across different API types within your backend services.

Backward compatibility requires deliberate versioning strategies and design patterns. This Skill enforces versioning approaches and conventions that prevent breaking changes, allowing clients to upgrade on their own timeline.

Authentication mechanisms vary by protocol and security requirements. This Skill provides standardized authentication approaches and templates for REST, GraphQL, and gRPC to enforce consistent security patterns across services.

AsyncAPI templates document asynchronous and event-driven APIs similar to how OpenAPI documents synchronous REST. This Skill includes AsyncAPI templates for consistent documentation of message-based interfaces alongside REST and gRPC services.