Api Error Design

samber/developer-platform-skills/skills/api-error-design

by samber594cf70d343eMIT3 starsListed Oct 8, 2026Updated Oct 8, 2026Repository updated 10 days ago

Design the error surface of a public API so integrators self-serve fixes - a machine-readable error-code taxonomy (flat catalog, code/subcode, Google-style domain/reason), the RFC 9457 problem-details envelope with extension members, actionable error messages, retryability signaling (retryable flag, Retry-After), and per-endpoint error documentation with request-ID tracking. Use whenever the user mentions API error codes, an error taxonomy, RFC 9457, application/problem+json, 4xx/5xx response bodies, or confusing API error messages - even if they never say "error design". Do NOT use for client-side retry mechanics - use samber/developer-platform-skills@api-idempotency-retry - nor for incident and status-page communication - use samber/developer-platform-skills@api-status-communication instead.

Instructions onlySoftware Development

Only the file list is public. File contents are available once the skill is installed in a workspace.

PathSizeType
evals/evals.json26.4 KBapplication/json
references/error-documentation-examples.md3.8 KBtext/markdown
references/message-rewrite-examples.md3.5 KBtext/markdown
references/rfc9457-payload-examples.md4.7 KBtext/markdown
references/taxonomy-catalog-examples.md5.4 KBtext/markdown
SKILL.md18 KBtext/markdown

Source and attribution

Source:samber/developer-platform-skillsinskills/api-error-designat commit594cf70

License: MIT

Content belongs to its original authors. SourceWeft indexes it from a public repository.

Report or request removal