Requiring that errors use the Problem Details for HTTP APIs standard.
Problem Details for HTTP APIs
Rules
OpenAPI Components Responses Info
Utilizing the responses object in the centralized OpenAPI components library helps make responses reusable across API requests
OpenAPI Components Responses Bad Request Error
Having a bad request responses in the centralized OpenAPI components library helps make error responses reusable across API requests
OpenAPI Components Responses Bad Request Info
Having a bad request responses in the centralized OpenAPI components library helps make error responses reusable across API requests
OpenAPI Components Responses Conflict Error
Having a conflict responses in the centralized OpenAPI components library helps make error responses reusable across API requests
OpenAPI Components Responses Conflict Info
Having a conflict responses in the centralized OpenAPI components library helps make error responses reusable across API requests
OpenAPI Components Responses Error
Utilizing the responses object in the centralized OpenAPI components library helps make responses reusable across API requests
OpenAPI Components Responses Forbidden Error
Having a forbidden responses in the centralized OpenAPI components library helps make error responses reusable across API requests
OpenAPI Components Responses Forbidden Info
Having a forbidden responses in the centralized OpenAPI components library helps make error responses reusable across API requests
OpenAPI Components Responses Internal Server Error Error
Having a internal server error responses in the centralized OpenAPI components library helps make error responses reusable across API requests
OpenAPI Components Responses Internal Server Error Info
Having a internal server error responses in the centralized OpenAPI components library helps make error responses reusable across API requests
OpenAPI Components Responses Not Found Error
Having a not found error responses in the centralized OpenAPI components library helps make error responses reusable across API requests
OpenAPI Components Responses Not Found Info
Having a not found error responses in the centralized OpenAPI components library helps make error responses reusable across API requests
OpenAPI Components Responses Too Many Requests Error
Having a too many requests error responses in the centralized OpenAPI components library helps make error responses reusable across API requests
OpenAPI Components Responses Too Many Requests Info
Having a too many requests error responses in the centralized OpenAPI components library helps make error responses reusable across API requests
OpenAPI Components Responses Unauthorized Error
Having a unauthorized error responses in the centralized OpenAPI components library helps make error responses reusable across API requests
OpenAPI Components Responses Unauthorized Info
Having a unauthorized error responses in the centralized OpenAPI components library helps make error responses reusable across API requests
Strategies
API Errors Are Standardized and Informative
All API error responses must follow standardized formats like RFC 7807 Problem Details, providing consistent error codes, human-readable messages, and correlation IDs that enable consumers to progr...
Lifecycle
balance Governance Production
Governance is how everything on this lifecycle stays aligned as an operation scales. Policies, rules, and standards applied consistently across teams are what keep APIs coherent without slowing eve...
