Gestion des versions d’API avec Nginx
Configurez Nginx pour prendre en charge différentes versions d’API, permettant des mises à niveau fluides et une rétrocompatibilité.
Gestion des versions d’API avec Nginx est une leçon API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) gratuite sur CoddyKit. Ceci est la leçon 1 sur 4. Tu peux lire la leçon complète ci-dessous gratuitement — puis la pratiquer en direct dans le navigateur avec un éditeur de code intégré et un tuteur IA 24/7. Elle fait partie du parcours d'apprentissage API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway), et ta progression se synchronise sur le web et l'application CoddyKit. Le cours API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) comprend 4 leçons au total.
Certaines parties de cette leçon n'ont pas encore été traduites et s'affichent en anglais.
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
locationblocks are ideal for URL-based versioning. - You can route different API versions to distinct backend services.
- Using
rewriterules, you can handle default or unversioned requests.
This allows you to evolve your APIs smoothly while maintaining service for all your users.
Questions Fréquemment Posées
La leçon « Gestion des versions d’API avec Nginx » est-elle gratuite ?
Oui — le texte complet de « Gestion des versions d’API avec Nginx » est gratuit à lire ici sur le web. Pour la pratiquer de manière interactive (un éditeur de code intégré et un tuteur IA 24/7) et déverrouiller le reste du cours API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway), passe à CoddyKit PRO. Le cours API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) comprend 4 leçons au total.
Qu'est-ce que j'apprendrai dans « Gestion des versions d’API avec Nginx » ?
Configurez Nginx pour prendre en charge différentes versions d’API, permettant des mises à niveau fluides et une rétrocompatibilité. Tu pratiques API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) avec du code pratique que tu exécutes directement dans le navigateur, et un tuteur IA 24/7 répond à tes questions au fur et à mesure que tu avances dans la leçon.
Dois-je avoir de l'expérience pour commencer API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) ?
Aucune expérience préalable n'est requise. API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) sur CoddyKit est structuré pour les débutants jusqu'aux apprenants avancés, donc tu peux commencer ici ou depuis le début et avancer à ton rythme. Ceci est la leçon 1 sur 4.
Combien de temps prend la leçon « Gestion des versions d’API avec Nginx » ?
La plupart des leçons CoddyKit prennent environ 5–10 minutes. Chacune est courte et interactive, tu progresses régulièrement et tu repiques exactement où tu t'es arrêté sur le web et l'app.
Peux-tu écrire et exécuter du code dans cette leçon API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) ?
Oui. Chaque leçon API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) inclut un éditeur de code intégré, tu écris et exécutes du vrai code directement dans ton navigateur et tu reçois des retours IA instantanés — aucune configuration locale requise.
Toutes les leçons de ce cours
- Gestion des versions d’API avec Nginx
- Partage de ressources entre origines (CORS)
- Limitation et régulation du débit avec Nginx
- Routage des microservices selon le chemin