API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) · Lektion

API-Versionierung mit Nginx

Konfigurieren Sie Nginx zur Unterstützung verschiedener API-Versionen und ermöglichen Sie so reibungslose Upgrades und Rückwärtskompatibilität.

API-Versionierung mit Nginx ist eine kostenlose API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)-Lektion auf CoddyKit. Dies ist Lektion 1 von 4. Du kannst die komplette Lektion unten kostenlos lesen – dann übst du sie direkt im Browser mit einem integrierten Code-Editor und einem KI-Tutor rund um die Uhr. Sie ist Teil des API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)-Lernpfads, und dein Fortschritt wird über Web und CoddyKit-App synchronisiert. Der API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)-Kurs umfasst insgesamt 4 Lektionen.

Teile dieser Lektion wurden noch nicht übersetzt und werden auf Englisch angezeigt.

What is API Versioning?

When you build APIs, they often change over time. New features are added, old ones removed, or logic is updated.

API versioning is a strategy to manage these changes without breaking existing applications that rely on your API.

It allows different versions of your API to coexist, supporting both older and newer clients simultaneously.

Why Versioning Matters

Imagine you update your API, and suddenly, all apps using the old API stop working. That's a bad experience!

Backward Compatibility: Ensures older clients continue to function.
Controlled Upgrades: Allows clients to migrate to new versions at their own pace.
Risk Management: Isolates changes, reducing the risk of widespread issues.

Common Versioning Approaches

There are several ways to indicate an API version:

URL Path: /api/v1/users
Custom Header: X-API-Version: 1
Query Parameter: /api/users?version=1

For Nginx, URL Path versioning is often the simplest and most common to implement using location blocks, which is what we'll focus on.

Nginx for URL-based Versioning

Nginx uses location blocks to match specific URL patterns. This is perfect for routing requests based on a version number in the path.

For example, requests to /api/v1/ can be sent to one backend, while requests to /api/v2/ go to another.

This allows you to deploy different versions of your API application, each serving its specific version.

Setting Up API Version 1

Let's configure Nginx to route requests for /api/v1/ to a backend server running our first API version.

We'll define an upstream block for our backend service and then a location block to proxy requests.

http {
  upstream api_v1_backend {
    server 192.168.1.10:8080;
  }

  server {
    listen 80;
    server_name example.com;

    location /api/v1/ {
      proxy_pass http://api_v1_backend/;
      proxy_set_header Host $host;
    }
  }
}

Adding API Version 2

Now, let's introduce a new version of our API. We'll set up a separate upstream and location block for /api/v2/, routing it to a different backend server.

This demonstrates how Nginx can direct traffic to completely separate application deployments based on the API version.

http {
  upstream api_v1_backend {
    server 192.168.1.10:8080;
  }

  upstream api_v2_backend {
    server 192.168.1.11:8081;
  }

  server {
    listen 80;
    server_name example.com;

    location /api/v1/ {
      proxy_pass http://api_v1_backend/;
      proxy_set_header Host $host;
    }

    location /api/v2/ {
      proxy_pass http://api_v2_backend/;
      proxy_set_header Host $host;
    }
  }
}

Handling Root/Default Version

What if a client doesn't specify a version? You can configure Nginx to redirect to the latest version or serve a default.

Using a rewrite rule, you can internally change the URI to point to /api/v2/ if the client requests /api/ without a version.

http {
  # ... upstream blocks ...

  server {
    listen 80;
    server_name example.com;

    # Redirect /api/ to /api/v2/ internally
    location = /api/ {
      rewrite ^ /api/v2/ permanent;
    }

    location /api/v1/ {
      proxy_pass http://api_v1_backend/;
      proxy_set_header Host $host;
    }

    location /api/v2/ {
      proxy_pass http://api_v2_backend/;
      proxy_set_header Host $host;
    }
  }
}

Prefix Matching & Trailing Slashes

Be careful with how location blocks match. A location /api/v1 will match /api/v1, /api/v1/, and /api/v1something.

Using location /api/v1/ (with a trailing slash) is generally safer as it matches /api/v1/ and its subpaths (e.g., /api/v1/users) but not /api/v10.

The proxy_pass directive also handles trailing slashes. If proxy_pass http://backend/; has a trailing slash, Nginx removes the matched part of the URI before passing it.

Best Practices for Versioning

To make your API versioning smooth and effective:

Document clearly: Inform clients about available versions and deprecation schedules.
Be consistent: Use the same versioning strategy across all your APIs.
Plan deprecation: Give ample notice before removing old versions.
Monitor usage: Track which versions are still in use to inform deprecation decisions.

Nginx Versioning Quiz

Consider the following Nginx configuration. Which proxy_pass destination would a request to http://example.com/api/v1/products be routed to?

server {
  listen 80;
  server_name example.com;

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

  location /api/v2/ {
    proxy_pass http://backend_new_api/;
  }

  location / {
    proxy_pass http://default_backend/;
  }
}

Recap: API Versioning with Nginx

You've learned how to implement API versioning using Nginx!

Versioning helps manage API changes and client compatibility.
Nginx's location blocks are ideal for URL-based versioning.
You can route different API versions to distinct backend services.
Using rewrite rules, you can handle default or unversioned requests.

This allows you to evolve your APIs smoothly while maintaining service for all your users.

Häufig gestellte Fragen

Ist die Lektion „API-Versionierung mit Nginx“ kostenlos?

Ja — der vollständige Text von „API-Versionierung mit Nginx“ ist hier im Web kostenlos zu lesen. Um sie interaktiv zu üben (integrierter Code-Editor und 24/7 KI-Tutor) und den Rest des API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)-Kurses freizuschalten, upgrade auf CoddyKit PRO. Der API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)-Kurs umfasst insgesamt 4 Lektionen.

Was lerne ich in „API-Versionierung mit Nginx“?

Konfigurieren Sie Nginx zur Unterstützung verschiedener API-Versionen und ermöglichen Sie so reibungslose Upgrades und Rückwärtskompatibilität. Du übst API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) mit praktischem Code, den du direkt im Browser ausführst, und ein 24/7 KI-Tutor beantwortet deine Fragen während du die Lektion bearbeitest.

Brauche ich Erfahrung, um API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) zu starten?

Keine Vorkenntnisse erforderlich. API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) auf CoddyKit ist für Anfänger bis fortgeschrittene Lernende strukturiert, sodass du hier starten oder von Anfang an beginnen und in deinem eigenen Tempo voranschreiten kannst. Dies ist Lektion 1 von 4.

Wie lange dauert die Lektion „API-Versionierung mit Nginx“?

Die meisten CoddyKit-Lektionen dauern etwa 5–10 Minuten. Jede ist kompakt und interaktiv, sodass du stetig Fortschritte machst und genau dort weitermachst, wo du aufgehört hast – im Web und in der App.

Kann ich in dieser API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)-Lektion Code schreiben und ausführen?

Ja. Jede API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)-Lektion enthält einen integrierten Code-Editor, sodass du echten Code direkt in deinem Browser schreibst und ausführst und sofort KI-Feedback erhältst — ohne lokale Einrichtung erforderlich.

Alle Lektionen in diesem Kurs

← Zurück zu API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)