errors-and-status-codes

What problem does it solve?

This Skill addresses the challenge of creating clear, consistent, and informative error responses for APIs, ensuring that developers integrating with your API can easily understand and handle issues.

Core Features & Use Cases

• HTTP Status Code Selection: Provides guidance on choosing the most appropriate HTTP status code (2xx, 3xx, 4xx, 5xx) for various error scenarios.
• Consistent Error Envelopes: Defines a standardized JSON structure for error responses, adhering to RFC 9457 Problem Details.
• Per-Field Validation: Details how to return specific validation errors for individual fields within a request.
• Use Case: When designing a new API endpoint, use this Skill to ensure all error responses follow best practices, including correct status codes, a well-defined error envelope, and actionable error messages, reducing integration friction for consumers.

Quick Start

Use the errors-and-status-codes skill to design a consistent error envelope for API responses.