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
You need a bad request responses in the centralized OpenAPI components library helps make error responses reusable across API requests
OpenAPI Components Responses Bad Request Info
You need a bad request responses in the centralized OpenAPI components library helps make error responses reusable across API requests
OpenAPI Components Responses Conflict Error
You need a conflict responses in the centralized OpenAPI components library helps make error responses reusable across API requests
OpenAPI Components Responses Conflict Info
You need 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
You need a forbidden responses in the centralized OpenAPI components library helps make error responses reusable across API requests
OpenAPI Components Responses Forbidden Info
You need a forbidden responses in the centralized OpenAPI components library helps make error responses reusable across API requests
OpenAPI Components Responses Internal Server Error Error
You need 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
You need 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
You need 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
You need 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
You need 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
You need 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
You need a unauthorized error responses in the centralized OpenAPI components library helps make error responses reusable across API requests
OpenAPI Components Responses Unauthorized Info
You need 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
Error handling is where I see the most inconsistency across the API landscape. Standardized error formats like RFC 7807, consistent error codes, human-readable messages, and correlation IDs--these ...