JSON error responses in Nginx - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a JSON error response in the context of nginx?

A JSON error response is a structured message sent by nginx to the client when an error occurs, formatted in JSON to make it easy for applications to understand and handle the error.

intermediate

How do you configure nginx to return a JSON error response?

You configure nginx to return JSON error responses by using the 'error_page' directive to specify a custom error page and then serving a JSON file or inline JSON content with the correct 'Content-Type: application/json' header.

beginner

What HTTP header must be set to indicate a JSON error response?

The HTTP header 'Content-Type: application/json' must be set to indicate that the response body contains JSON data.

beginner

Example of a simple JSON error response body?

{"error": {"code": 404, "message": "Not Found"}}

intermediate

Why use JSON error responses instead of plain text in APIs?

JSON error responses allow clients to easily parse and handle errors programmatically, improving automation and user experience compared to plain text messages.

Which nginx directive is used to specify a custom error page?

A location

B proxy_pass

C error_page

D return

The 'error_page' directive tells nginx which page or response to serve when a specific error occurs.

What Content-Type header should be set for JSON error responses?

A application/json

B text/html

C text/plain

D application/xml

The 'application/json' header indicates the response body is JSON formatted.

What is the main benefit of JSON error responses in APIs?

A They are easier for humans to read

B They improve network speed

C They reduce server load

D They allow clients to parse errors programmatically

JSON error responses let client programs understand and react to errors automatically.

Which HTTP status code is commonly used for 'Not Found' errors?

A 200

B 404

C 301

D 500

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

In nginx, how can you serve a JSON error response inline without a separate file?

A Using 'return' with JSON string and setting Content-Type

B Using 'proxy_pass' to a JSON server

C Using 'rewrite' directive

D Using 'listen' directive

You can use 'return' with a status code and JSON string, plus 'add_header' to set Content-Type.

Explain how to configure nginx to return a JSON error response for a 404 error.

Think about how nginx handles error pages and headers.

Why is it important to set the Content-Type header correctly when returning JSON error responses?

Consider how clients read and use the response data.