Cloud-Native Applications in Java

Handling errors

Make use of the standard HTTP status code to indicate the problem/error:

• If using JSON, the error should be a top-level property
• With errors—be descriptive, correct, and informative

A sample error message is as shown in the following snippet:

{ 
   "type": "error", 
   "status":400, 
   "code": "bad_request", 
   "context_info": { 
         "errors": [ 
         { 
               "reason": "missing_argument", 
               "message": "order_id is required", 
               "name": "order_id", 
               "location": "query_param" 
         } 
         ] 
   }, 
   "help_url": "http://developers.some.com/api/docs/#error_code", 
   "message": "Bad Request" 
   "request_id": "8233232980923412494933" 
} 

Some examples of HTTP code usage are as follows:

• 400 Bad Request
• 401 Unauthorized
• 403 Forbidden
• 404 Not Found
• 409 Conflict
• 429 Too Many Requests
• 5xx API ...