Requiring that all 5xx responses meets the policy standards.
Response 5xx
Rules
OpenAPI Response Get 500 Status Code Error
GET responses needs a 500 internal server erorr HTTP status code, communicating the API had a problem to consumers
OpenAPI Response Get 500 Status Code Info
GET responses needs a 500 internal server erorr HTTP status code, communicating the API had a problem to consumers
OpenAPI Response Get 500 Schema Ref Error
GET 500 internal server error requests HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Get 500 Schema Ref Info
GET 500 internal server error requests HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Post 500 Status Code Error
POST responses needs a 500 internal server erorr HTTP status code, communicating the API had a problem to consumers
OpenAPI Response Post 500 Status Code Info
POST responses needs a 500 internal server erorr HTTP status code, communicating the API had a problem to consumers
OpenAPI Response Post 500 Schema Ref Error
POST 500 internal server error requests HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Post 500 Schema Ref Info
POST 500 internal server error requests HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Put 500 Status Code Error
PUT responses needs a 500 internal server erorr HTTP status code, communicating the API had a problem to consumers
OpenAPI Response Put 500 Status Code Info
PUT responses needs a 500 internal server erorr HTTP status code, communicating the API had a problem to consumers
OpenAPI Response Put 500 Schema Ref Error
PUT 500 internal server error requests HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Put 500 Schema Ref Info
PUT 500 internal server error requests HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Delete 500 Status Code Error
DELETE responses needs a 500 internal server erorr HTTP status code, communicating the API had a problem to consumers
OpenAPI Response Delete 500 Status Code Info
DELETE responses needs a 500 internal server erorr HTTP status code, communicating the API had a problem to consumers
OpenAPI Response Delete 500 Schema Ref Error
DELETE 500 internal server error requests HTTP status codes have a schema references to standardize the response payload returned for the error response
OpenAPI Response Delete 500 Schema Ref Info
DELETE 500 internal server error requests HTTP status codes have a schema references to standardize the response payload returned for the error response
Strategies
API Responses Must Be Meaningful and Consistent
I keep seeing APIs where responses feel like a total afterthought. Inconsistent structures, missing status codes, no examples. The reality is your responses are the conversation you are having with...
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 ...