designing-resilient-apis

What problem does it solve?

This Skill prevents common API pitfalls like inconsistent errors, lack of idempotency, broken pagination, and unversioned contracts, ensuring your APIs are stable and predictable.

Core Features & Use Cases

• API Versioning: Enforces clear versioning strategies (URL or header).
• Idempotency: Ensures mutations can be retried safely without side effects.
• Standardized Errors: Implements RFC 7807 for consistent error reporting.
• Pagination: Guides implementation of cursor-based pagination for large datasets.
• Input Validation: Promotes using tools like Zod at the API boundary.
• Use Case: Reviewing a new /api/users endpoint to ensure it supports idempotency keys for POST requests and uses cursor-based pagination for the GET all users endpoint.

Quick Start

Ensure the API endpoint for creating a new user includes an idempotency key header and returns RFC 7807 compliant errors.