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

使用 Nginx 实现 API 版本管理

配置 Nginx 以支持不同的 API 版本，实现平滑升级和向后兼容。

使用 Nginx 实现 API 版本管理 是 CoddyKit 上的免费 API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) 课时。这是第 1 节课，共 4 节。你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。这是 API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) 学习路径的一部分，你的进度在网页和 CoddyKit 应用中同步。 API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) 课程共包含 4 节课。

本课时的部分内容尚未翻译，以英文显示。

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.

常见问题解答

「使用 Nginx 实现 API 版本管理」课时是免费的吗？

是的 — 「使用 Nginx 实现 API 版本管理」的完整文本可在网页上免费阅读。要进行交互式练习（内置代码编辑器和全天候 AI 导师）并解锁 API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) 课程的其余内容，请升级到 CoddyKit PRO。 API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) 课程共包含 4 节课。

「使用 Nginx 实现 API 版本管理」这节课中我会学到什么？

配置 Nginx 以支持不同的 API 版本，实现平滑升级和向后兼容。你通过在浏览器中直接运行的动手代码来练习 API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)，全天候 AI 导师会在你学习这节课的过程中回答你的问题。

学习 API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) 需要有经验吗？

无需任何先前经验。CoddyKit 上的 API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) 课程适合初学者到高级学习者，你可以从这里开始或从头开始，按照自己的节奏学习。这是第 1 节课，共 4 节。

「使用 Nginx 实现 API 版本管理」课时需要多长时间？

大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动，所以你能稳步进步，并在网页和应用中从离开的地方继续。

我能在这节 API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) 课中编写并运行代码吗？

能。每节 API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) 课都包含内置代码编辑器，你可以在浏览器中直接编写并运行真实代码，并获得即时 AI 反馈 — 无需本地设置。

此课程中的所有课时

← 返回 API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)