Error Handling

{
  "error": "error_code",
  "error_description": "Human-readable error message"
}

{
  "error": "validation_failed",
  "error_description": "Validation failed: name is required"
}

{
  "error": "invalid_token",
  "error_description": "Token is invalid or expired"
}

{
  "error": "forbidden",
  "error_description": "You do not have permission to perform this action"
}

{
  "error": "not_found",
  "error_description": "Project 'MyProject' not found"
}

{
  "error": "duplicate_name",
  "error_description": "API Proxy with name 'MyAPI' already exists"
}

{
  "error": "internal_error",
  "error_description": "An unexpected error occurred. Please try again later."
}

# Good
if response.status_code == 200:
    process_success(response.json())
else:
    handle_error(response.json())

# Bad
process_success(response.json())  # May fail on error responses

{
  "error": "validation_failed",
  "error_description": "Field 'name' is required"
}

if error_code == "invalid_token":
    refresh_token()
elif error_code == "not_found":
    log_not_found(resource_name)
elif error_code == "validation_failed":
    show_validation_errors(error_description)

max_retries = 3
for attempt in range(max_retries):
    try:
        response = make_request()
        if response.status_code == 200:
            return response
    except Exception as e:
        if attempt == max_retries - 1:
            raise
        time.sleep(2 ** attempt)  # Exponential backoff

logger.error(f"API Error: {error_code} - {error_description}")
logger.debug(f"Request: {request_url}")
logger.debug(f"Response: {response_body}")

{
  "error": "validation_failed",
  "error_description": "Validation failed",
  "validation_errors": [
    {
      "field": "name",
      "message": "Name is required"
    },
    {
      "field": "email",
      "message": "Invalid email format"
    }
  ]
}

{
  "error": "rate_limit_exceeded",
  "error_description": "Rate limit exceeded. Please try again later.",
  "retry_after": 60
}