Error response format in Rest API - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is an error response format in REST APIs?

It is a standard way to send error details from the server to the client, usually in JSON, so the client understands what went wrong.

beginner

Why should error responses include a status code?

Status codes tell the client the type of error (like 404 for not found or 500 for server error) so it can handle the problem properly.

beginner

Name three common fields in a REST API error response.

Common fields are: <br>1. status - HTTP status code<br>2. error - short error name<br>3. message - human-readable explanation

intermediate

What is the benefit of including an error code in the response body?

An error code helps the client identify the exact problem programmatically, beyond just the HTTP status code.

beginner

How can error response formats improve user experience?

Clear error messages help users understand what went wrong and how to fix it, reducing frustration and support requests.

Which HTTP status code usually means 'Resource Not Found'?

A 200

B 404

C 500

D 301

404 means the requested resource was not found on the server.

What field in an error response typically contains a human-readable explanation?

A message

B error_code

C status

D timestamp

The 'message' field explains the error in simple words.

Why include both HTTP status code and error code in a response?

A To provide both general and specific error info

B To increase response size

C Because HTTP requires it

D To confuse the client

HTTP status gives general error type; error code gives specific details.

Which of these is NOT a good practice for error responses?

A Provide error codes for programmatic handling

B Use standard HTTP status codes

C Include clear error messages

D Return empty body on error

Returning an empty body on error makes it hard for clients to understand the problem.

What is a common format for REST API error responses?

A XML

B CSV

C JSON

D Plain text

JSON is the most common and easy-to-use format for REST API error responses.

Describe the key components of a good REST API error response format.

Think about what helps both humans and programs understand the error.

Explain why consistent error response formats are important in REST APIs.

Consider how clients and developers benefit from consistency.