Why Nginx handles API routing - See It in Action

Why Nginx Handles API Routing

📖 Scenario: You are working on a web application that has a frontend and a backend API. The backend API runs on a different server or port. You want to use Nginx as a reverse proxy to route API requests to the backend server while serving the frontend files directly.This setup helps keep your application organized and improves performance by letting Nginx handle routing efficiently.

🎯 Goal: Learn how to configure Nginx to route API requests to a backend server while serving frontend files from the same domain.

📋 What You'll Learn

Create a basic Nginx server block to serve frontend files

Add a variable to define the backend API server address

Configure Nginx to route requests starting with /api/ to the backend API server

Print the final Nginx configuration to verify the routing setup

💡 Why This Matters

🌍 Real World

Nginx is often used as a reverse proxy to route API requests to backend servers while serving frontend files. This helps organize traffic and improve performance.

💼 Career

Understanding how to configure Nginx for API routing is a key skill for DevOps engineers and backend developers working with web applications.

1

Create a basic Nginx server block

Write an Nginx server block that listens on port 80 and serves static files from /var/www/html for all requests.

Nginx

# Your code here

Hint

Use server {} block with listen 80; and location / { root /var/www/html; index index.html; }.

2

Add a variable for the backend API server

Inside the server block, add a variable called $backend_api and set it to http://localhost:5000 to represent the backend API server address.

Nginx

server {
    listen 80;
    server_name localhost;

    set $backend_api http://localhost:5000;

    location / {
        root /var/www/html;
        index index.html;
    }
    # Your code here
}

Hint

Use set $backend_api http://localhost:5000; inside the server block.

3

Configure API routing to the backend server

Add a location /api/ {} block inside the server block that proxies requests to the backend API server using the $backend_api variable. Use proxy_pass $backend_api; inside this location.

Nginx

server {
    listen 80;
    server_name localhost;

    set $backend_api http://localhost:5000;

    location / {
        root /var/www/html;
        index index.html;
    }

    # Add location /api/ block here
}

Hint

Use location /api/ { proxy_pass $backend_api; } inside the server block.

4

Print the final Nginx configuration

Print the entire Nginx configuration to verify that the server block listens on port 80, serves static files from /var/www/html, and routes /api/ requests to $backend_api.

Nginx

# Your code here

Hint

Print the full configuration text exactly as shown.

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