api-error-handling
Implement comprehensive API error handling with standardized error responses, logging, monitoring, retry logic, and validation patterns. Use when building resilient APIs, debugging issues, improving error reporting, implementing retry logic, handling HTTP error codes, managing API timeouts, designin
By aj-geddes · 493 installs
npx skills add aj-geddes/useful-ai-prompts --skill api-error-handling
Source repository · Upstream listing
API Error Handling
Table of Contents
[Overview]( overview)
[When to Use]( when to use)
[Quick Start]( quick start)
[Reference Guides]( reference guides)
[Best Practices]( best practices)
Overview
Build robust error handling systems with standardized error responses, detailed
logging, error categorization, and user friendly error messages. This skill
covers the full lifecycle from throwing typed errors through logging, monitoring,
and client facing response formatting.
When to Use
Handling API errors consistently across endpoints
Debugging production issues with request tracing
Implementing error recovery strategies (retry, circuit breaker)
Monitoring and alerting on error rates
Providing meaningful, actionable error messages to clients
Validating request inputs before processing
Tracking error patterns over time
Quick Start
Minimal standardized error response format:
Custom error class (Node.js):
Reference Guides
Detailed implementations in the references/ directory:
Guide Contents
[Error Codes & Response Format](references/error codes reference.md) Complete ERROR CODES map, response formatter, global middleware (Node.js + Python)
[Retry Strategies & Circuit Breaker](references/retry strategies.md) Exponential backoff, jitter, circuit breaker pattern
[Monitoring & Tracking](references/monitoring patterns.md) Sentry integration, error rate metrics, /metrics/errors endpoint
[Validation Patterns](references/validation examples.md) Input validation, schema guards, detecting bad responses before errors occur
Best Practices
✅ DO
Use a consistent error response format across all endpoints
Include requestId and traceId in every error for observability
Log 5xx errors at ERROR level; log 4xx at WARN level
Provide actionable error messages — tell the client what to fix
Use standard HTTP status codes (4xx client errors, 5xx server errors)
Implement retry with exponential backoff for transient failures
Use circuit breakers to prevent cascade failures
Validate inputs early and return all field errors at once
Monitor error rates and alert on anomalous spikes
❌ DON'T
Expose stack traces or internal implementation details to clients
Return HTTP 200 for error responses
Silently swallow errors
Log sensitive data (passwords, tokens, PII)
Use vague messages like "Something went wrong"
Mix error handling logic with business logic
Retry non idempotent operations or client errors (4xx)
Return different error shapes from different endpoints