JSON error responses in Nginx - Mini Project: Build & Apply

JSON Error Responses in Nginx

📖 Scenario: You are setting up a web server using Nginx. You want to make sure that when users encounter errors like 404 or 500, they get a clear message in JSON format instead of the default HTML error page.

🎯 Goal: Configure Nginx to return JSON formatted error responses for HTTP status codes 404 and 500.

📋 What You'll Learn

Create a basic Nginx server block configuration

Add a variable to hold the JSON error message

Use the error_page directive to handle 404 and 500 errors

Return the JSON error message with the correct content type

Test the configuration by simulating 404 and 500 errors

💡 Why This Matters

🌍 Real World

Web servers often need to return error messages in JSON format for APIs or modern web apps that expect JSON responses instead of HTML error pages.

💼 Career

Knowing how to customize error responses in Nginx is a valuable skill for DevOps engineers and backend developers managing web infrastructure.

1

Create a basic Nginx server block

Create a basic Nginx server block listening on port 80 with the server name localhost. Inside the server block, add a location / block that returns a 200 status with the text "Welcome to Nginx".

Nginx

# Your code here

Hint

Use server {} block with listen 80; and server_name localhost;. Inside location / {}, use return 200 'Welcome to Nginx';.

2

Add a variable for JSON error message

Inside the server block, create a variable called $json_error that holds the JSON string {"error": "Resource not found"}.

Nginx

server {
    listen 80;
    server_name localhost;

    # Define JSON error message variable
    # Your code here

    location / {
        return 200 'Welcome to Nginx';
    }
}

Hint

Use the set directive to assign the JSON string to $json_error.

3

Configure error_page for 404 and 500 errors

Add error_page directives inside the server block to handle HTTP status codes 404 and 500. For both errors, redirect to /json_error location.

Nginx

server {
    listen 80;
    server_name localhost;

    set $json_error '{"error": "Resource not found"}';

    # Add error_page directives for 404 and 500
    # Your code here

    location / {
        return 200 'Welcome to Nginx';
    }
}

Hint

Use error_page 404 /json_error; and error_page 500 /json_error; inside the server block.

4

Create /json_error location to return JSON error

Add a location /json_error block inside the server block. Inside it, set the Content-Type header to application/json and return the $json_error variable with status 200.

Nginx

server {
    listen 80;
    server_name localhost;

    set $json_error '{"error": "Resource not found"}';

    error_page 404 /json_error;
    error_page 500 /json_error;

    location / {
        return 200 'Welcome to Nginx';
    }

    # Add location /json_error block below
    # Your code here
}

Hint

Use location /json_error {} with default_type application/json; and return 200 $json_error;.

Practice

1. What is the main benefit of sending JSON error responses in nginx?

easy

A. They automatically fix server errors without manual intervention.

B. They make error information easy for applications to read and process.

C. They reduce the size of error messages to save bandwidth.

D. They prevent users from seeing any error messages.

Solution

1. Step 1: Understand JSON error response purpose

   JSON error responses format error details in a way apps can easily parse and handle.

2. Step 2: Compare options

   Only They make error information easy for applications to read and process. correctly states the benefit of JSON error responses; others are incorrect or unrelated.

3. Final Answer:

   They make error information easy for applications to read and process. -> Option B

4. Quick Check:

   JSON error responses = easy app reading [OK]

Hint: JSON errors help apps read errors clearly [OK]

Common Mistakes:

• Thinking JSON errors fix server issues automatically
• Believing JSON errors hide all error messages
• Assuming JSON errors reduce bandwidth significantly

2. Which nginx directive is used to specify a custom error page that returns JSON?

easy

A. error_page

B. listen

C. proxy_pass

D. server_name

Solution

1. Step 1: Identify directive for custom error pages

   The error_page directive tells nginx which page to serve on specific errors.

2. Step 2: Eliminate unrelated directives

   proxy_pass forwards requests, listen sets ports, server_name sets domain names; none define error pages.

3. Final Answer:

   error_page -> Option A

4. Quick Check:

   Custom error page directive = error_page [OK]

Hint: Use error_page to set custom error responses [OK]

Common Mistakes:

• Confusing proxy_pass with error_page
• Using listen or server_name for error handling
• Forgetting to set content type for JSON

3. Given this nginx config snippet, what is the JSON response body for a 404 error?

error_page 404 /404.json;
location = /404.json {
  internal;
  default_type application/json;
  return 404 '{"error":"Not Found"}';
}

medium

A. 404 Not Found

B. Not Found

C. {"error":"Not Found"}

D. Error 404

Solution

1. Step 1: Analyze the error_page and location block

   The 404 error triggers /404.json, which is internal and returns JSON with content type application/json.

2. Step 2: Check the return statement

   The return sends status 404 with JSON string '{"error":"Not Found"}' as the body.

3. Final Answer:

   {"error":"Not Found"} -> Option C

4. Quick Check:

   Return JSON string = {"error":"Not Found"} [OK]

Hint: Look at return content for JSON body [OK]

Common Mistakes:

• Assuming default HTML error page is returned
• Ignoring internal directive effect
• Confusing status code text with response body

4. You configured nginx to return JSON errors but clients receive HTML error pages instead. What is the likely mistake?

medium

A. The server_name directive is not set.

B. The error_page directive is missing or incorrect.

C. The return directive uses invalid JSON syntax.

D. The internal directive is missing in the error location block.

Solution

1. Step 1: Understand internal directive role

   The internal directive prevents direct client access to error pages, ensuring nginx uses them only for error responses.

2. Step 2: Identify why HTML is returned

   If internal is missing, clients can access the error page URL directly, causing nginx to serve default HTML instead of JSON error.

3. Final Answer:

   The internal directive is missing in the error location block. -> Option D

4. Quick Check:

   Missing internal = HTML errors shown [OK]

Hint: Always mark error locations internal for JSON errors [OK]

Common Mistakes:

• Forgetting internal causes direct access to error pages
• Blaming server_name for error response format
• Assuming JSON syntax error causes HTML output

5. How would you configure nginx to return a JSON error response with status 500 and body {"error":"Server Error"} using an internal location?

hard

A. error_page 500 /500.json;
location = /500.json {
internal;
default_type application/json;
return 500 '{"error":"Server Error"}';
}

B. error_page 500 /500.html;
location = /500.html {
internal;
default_type text/html;
return 500 'Server Error';
}

C. location /500.json {
return 500 '{"error":"Server Error"}';
}

D. error_page 500 /500.json;
location /500.json {
default_type application/json;
return 500 '{"error":"Server Error"}';
}

Solution

1. Step 1: Use error_page to map 500 to JSON location

   The directive error_page 500 /500.json; tells nginx to use /500.json for 500 errors.

2. Step 2: Define internal location with JSON content type and return JSON body

   The location must be internal to prevent direct access, set default_type application/json;, and return the JSON string with status 500.

3. Step 3: Verify options

   error_page 500 /500.json; location = /500.json { internal; default_type application/json; return 500 '{"error":"Server Error"}'; } matches all requirements. error_page 500 /500.html; location = /500.html { internal; default_type text/html; return 500 '

   Server Error

   '; } uses HTML. The others lack the internal directive or miss the error_page directive.

4. Final Answer:

   error_page 500 /500.json; location = /500.json { internal; default_type application/json; return 500 '{"error":"Server Error"}'; } -> Option A

5. Quick Check:

   Use error_page + internal + JSON return [OK]

Hint: Map error_page, mark internal, set JSON content, return JSON [OK]

Common Mistakes:

• Omitting internal directive
• Using wrong content type
• Not escaping JSON properly
• Not mapping error_page to location