0Pricing
API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) · Aula

Versionamento de APIs com Nginx

Configure o Nginx para oferecer suporte a diferentes versões de API, permitindo atualizações contínuas e compatibilidade retroativa.

Versionamento de APIs com Nginx é uma aula grátis de API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) no CoddyKit. Esta é a aula 1 de 4. Você pode ler a aula completa abaixo gratuitamente — depois pratica ao vivo no navegador com um editor de código integrado e um tutor de IA 24/7. Faz parte do caminho de aprendizado de API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway), e seu progresso é sincronizado entre a web e o app CoddyKit. O curso de API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) inclui 4 aulas no total.

Partes desta aula ainda não foram traduzidas e aparecem em inglês.

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.

Perguntas Frequentes

A aula “Versionamento de APIs com Nginx” é grátis?

Sim — o texto completo de “Versionamento de APIs com Nginx” é grátis para ler aqui na web. Para praticá-la interativamente (um editor de código integrado e um tutor de IA 24/7) e desbloquear o restante do curso de API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway), atualize para CoddyKit PRO. O curso de API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) inclui 4 aulas no total.

O que vou aprender em “Versionamento de APIs com Nginx”?

Configure o Nginx para oferecer suporte a diferentes versões de API, permitindo atualizações contínuas e compatibilidade retroativa. Você pratica API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) com código prático que executa diretamente no navegador, e um tutor de IA 24/7 responde suas dúvidas enquanto trabalha na aula.

Preciso ter experiência prévia para começar API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)?

Nenhuma experiência prévia é necessária. API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) no CoddyKit é estruturado para alunos iniciantes até avançados, então você pode começar aqui ou desde o início e aprender no seu ritmo. Esta é a aula 1 de 4.

Quanto tempo leva a aula “Versionamento de APIs com Nginx”?

A maioria das aulas CoddyKit leva cerca de 5–10 minutos. Cada uma é compacta e interativa, então você faz progresso constante e retoma exatamente de onde parou entre web e app.

Posso escrever e executar código nesta aula de API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)?

Sim. Cada aula de API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) inclui um editor de código integrado, então você escreve e executa código real direto no navegador e recebe feedback de IA instantaneamente — nenhuma configuração local necessária.

Todas as aulas deste curso

  1. Versionamento de APIs com Nginx
  2. Compartilhamento de Recursos entre Origens (CORS)
  3. Limitação de Taxa e Controle de Fluxo com Nginx
  4. Roteamento baseado em caminho para microsserviços
← Voltar para API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)