Why Nginx handles API routing - Challenge Your Understanding

Challenge - 5 Problems

🧠 Conceptual

intermediate

Why use Nginx for API routing?

Which reason best explains why Nginx is commonly used to handle API routing?

A Nginx can efficiently forward API requests to different backend services based on URL patterns.

B Nginx automatically writes API code for backend services.

C Nginx stores API data permanently for faster access.

D Nginx replaces the need for backend servers entirely.

💡 Hint

Think about what Nginx does with incoming web requests before they reach backend servers.

Nginx acts as a reverse proxy that routes API requests to the correct backend service based on the request path. It does not write code, store data, or replace backend servers.

💻 Command Output

intermediate

Nginx API routing configuration output

Given this Nginx config snippet, what will be the output when a request is made to /api/users?

location /api/ {
    proxy_pass http://backend_service;
}

A The request is forwarded to the backend_service at /api/users.

B Nginx returns a 404 Not Found error.

C The request is served from Nginx's local files.

D Nginx returns a 500 Internal Server Error.

💡 Hint

Consider what proxy_pass does inside a location block.

The proxy_pass directive forwards matching requests to the specified backend service. Here, requests to /api/users go to http://backend_service/api/users.

❓ Configuration

advanced

Correct Nginx config for API routing with path rewrite

Which Nginx configuration correctly routes requests from /api/v1/ to http://backend_service/v1/ by removing the /api prefix?

A

location /api/v1/ {
    proxy_pass http://backend_service;
}

B

location /api/v1/ {
    proxy_pass http://backend_service/v1/;
}

C

location /api/v1/ {
    proxy_pass http://backend_service/;
}

D

location /api/v1/ {
    proxy_pass http://backend_service/api/v1/;
}

💡 Hint

Remember that adding a trailing slash to proxy_pass changes how the path is forwarded.

Using proxy_pass http://backend_service/v1/; with a trailing slash rewrites the path by replacing /api/v1/ with /v1/. Other options either keep the prefix or forward incorrectly.

❓ Troubleshoot

advanced

Why does Nginx return 502 Bad Gateway for API requests?

You configured Nginx to route API requests to a backend service, but Nginx returns a 502 Bad Gateway error. What is the most likely cause?

A The API request URL is malformed.

B Nginx configuration syntax is invalid.

C The backend service is not running or unreachable from Nginx.

D Nginx does not support API routing.

💡 Hint

502 Bad Gateway means Nginx could not get a valid response from the backend.

A 502 error usually means Nginx tried to forward the request but the backend service was down or unreachable. Syntax errors cause config reload failures, malformed URLs cause client errors, and Nginx supports API routing.

✅ Best Practice

expert

Best practice for securing API routing in Nginx

Which Nginx configuration practice best improves security when routing API requests?

A Use <code>proxy_pass</code> without HTTPS to speed up API calls.

B Disable all logging to avoid exposing API usage data.

C Allow all IP addresses unrestricted access to API routes.

D Use <code>limit_req</code> to limit request rate and <code>auth_basic</code> for simple authentication on API endpoints.

💡 Hint

Think about how to protect APIs from abuse and unauthorized access.

Rate limiting prevents abuse, and basic authentication adds a simple access control layer. Disabling logs reduces visibility, unrestricted access is insecure, and skipping HTTPS exposes data to interception.

Practice

1. Why is Nginx commonly used to handle API routing in web applications?

easy

A. Because it replaces the need for backend servers

B. Because it efficiently directs API requests to the correct backend services

C. Because it stores API data permanently

D. Because it automatically writes API documentation

Solution

1. Step 1: Understand Nginx's role in routing

   Nginx acts as a traffic controller, sending API requests to the right backend service based on rules.

2. Step 2: Identify what Nginx does not do

   Nginx does not store data, replace backend servers, or write documentation; it only routes requests.

3. Final Answer:

   Because it efficiently directs API requests to the correct backend services -> Option B

4. Quick Check:

   Routing = directing requests [OK]

Hint: Nginx routes requests, it doesn't store or create data [OK]

Common Mistakes:

• Thinking Nginx stores API data
• Believing Nginx replaces backend servers
• Assuming Nginx writes API docs

2. Which Nginx directive is used to forward API requests to a backend server?

easy

A. proxy_pass

B. listen

C. server_name

D. root

Solution

1. Step 1: Identify the directive for forwarding requests

   The proxy_pass directive tells Nginx where to send the incoming API requests.

2. Step 2: Differentiate from other directives

   listen sets the port, server_name sets the domain, and root sets the file path, none forward requests.

3. Final Answer:

   proxy_pass -> Option A

4. Quick Check:

   Forwarding = proxy_pass [OK]

Hint: proxy_pass sends requests to backend servers [OK]

Common Mistakes:

• Confusing listen with proxy_pass
• Using root to forward requests
• Mixing server_name with routing

3. Given this Nginx config snippet, what backend URL will a request to /api/users be forwarded to?

location /api/ {
    proxy_pass http://backend-service:8080/;
}

medium

A. http://backend-service:8080/api/users

B. http://backend-service:8080/

C. http://backend-service:8080/api/

D. http://backend-service:8080/users

Solution

1. Step 1: Understand proxy_pass with trailing slash

   Since proxy_pass ends with a slash, Nginx replaces the matching /api/ part in the request URL with the backend URL.

2. Step 2: Apply URL rewrite logic

   Request /api/users becomes /users appended to http://backend-service:8080/, resulting in http://backend-service:8080/users.

3. Final Answer:

   http://backend-service:8080/users -> Option D

4. Quick Check:

   Trailing slash rewrites path [OK]

Hint: Trailing slash in proxy_pass rewrites matched path [OK]

Common Mistakes:

• Appending full original path without rewrite
• Ignoring trailing slash effect
• Assuming no path change

4. Identify the error in this Nginx config that prevents API routing:

location /api {
    proxy_pass http://backend-service:8080;
}

medium

A. Missing trailing slash in location path

B. proxy_pass must use HTTPS instead of HTTP

C. proxy_pass URL missing trailing slash causing path issues

D. location directive should be inside server block

Solution

1. Step 1: Check proxy_pass URL format

   The proxy_pass URL lacks a trailing slash, so Nginx appends the full original request URI, causing incorrect backend paths.

2. Step 2: Understand impact on routing

   Without the trailing slash, requests like /api/users become http://backend-service:8080/api/users which may not be expected by backend.

3. Final Answer:

   proxy_pass URL missing trailing slash causing path issues -> Option C

4. Quick Check:

   Trailing slash in proxy_pass fixes path [OK]

Hint: Always add trailing slash in proxy_pass for correct routing [OK]

Common Mistakes:

• Ignoring trailing slash importance
• Thinking location path needs trailing slash
• Assuming HTTPS is mandatory

5. You want Nginx to route requests starting with /api/v1/ to http://v1-backend:9000/ and requests starting with /api/v2/ to http://v2-backend:9000/. Which configuration correctly achieves this?

hard

A. location /api/v1/ { proxy_pass http://v1-backend:9000/; }\nlocation /api/v2/ { proxy_pass http://v2-backend:9000/; }

B. location /api/ { proxy_pass http://v1-backend:9000/; }\nlocation /api/ { proxy_pass http://v2-backend:9000/; }

C. location /api/v1 { proxy_pass http://v1-backend:9000; }\nlocation /api/v2 { proxy_pass http://v2-backend:9000; }

D. location /api/v1/ { proxy_pass http://v2-backend:9000/; }\nlocation /api/v2/ { proxy_pass http://v1-backend:9000/; }

Solution

1. Step 1: Match location blocks to API versions

   Separate location blocks for /api/v1/ and /api/v2/ ensure requests route to correct backend.

2. Step 2: Use trailing slashes in proxy_pass URLs

   Trailing slashes in proxy_pass ensure correct path rewriting for backend services.

3. Step 3: Verify options

   location /api/v1/ { proxy_pass http://v1-backend:9000/; }\nlocation /api/v2/ { proxy_pass http://v2-backend:9000/; } correctly matches paths and proxies to correct backends. location /api/ { proxy_pass http://v1-backend:9000/; }\nlocation /api/ { proxy_pass http://v2-backend:9000/; } duplicates location blocks, location /api/v1 { proxy_pass http://v1-backend:9000; }\nlocation /api/v2 { proxy_pass http://v2-backend:9000; } misses trailing slashes, location /api/v1/ { proxy_pass http://v2-backend:9000/; }\nlocation /api/v2/ { proxy_pass http://v1-backend:9000/; } swaps backends incorrectly.

4. Final Answer:

   location /api/v1/ { proxy_pass http://v1-backend:9000/; }\nlocation /api/v2/ { proxy_pass http://v2-backend:9000/; } -> Option A

5. Quick Check:

   Separate locations + trailing slash = correct routing [OK]

Hint: Use distinct location blocks with trailing slashes for each API version [OK]

Common Mistakes:

• Using same location for different APIs
• Missing trailing slashes causing path errors
• Swapping backend URLs by mistake