Formations — 1 037 leçons en français

Accueil › Spring Boot › API Gateway avec Spring Cloud Gateway

API Gateway avec Spring Cloud Gateway

Microservices avec Spring Cloudavance

Une API Gateway est le point d'entrée unique d'un système de microservices : elle route les requêtes entrantes vers le bon service et centralise ce qui serait sinon dupliqué dans chacun (authentification, limitation de débit, en-têtes communs). Spring Cloud Gateway s'appuie sur trois notions :

spring:
  cloud:
    gateway:
      routes:
        - id: catalogue
          uri: lb://service-catalogue
          predicates:
            - Path=/api/catalogue/**
          filters:
            - StripPrefix=1
            - AddRequestHeader=X-Gateway-Source, gateway

lb://service-catalogue fait résoudre la destination via la découverte de services (Eureka) et Spring Cloud LoadBalancer, au lieu d'une adresse fixe. Spring Cloud Gateway est historiquement construit sur WebFlux (non bloquant) : profil d'usage adapté à une brique qui passe l'essentiel de son temps à attendre les réponses des services en aval.

La gateway doit rester une brique d'infrastructure : routage, sécurité transverse, limitation de débit. La logique métier reste dans les services.

Les termes à connaître

API Gateway

Point d'entrée unique d'un système de microservices, placé devant eux. Elle route chaque requête entrante vers le bon service, et centralise des préoccupations transverses (authentification, limitation de débit, en-têtes communs) pour éviter de les dupliquer dans chaque service.

Route

Unité de configuration de Spring Cloud Gateway : un identifiant, une destination (uri), une liste de predicates (conditions de correspondance) et une liste de filters (transformations appliquées si la route correspond).

Predicate

Condition qui détermine si une requête entrante correspond à une route : chemin (Path=), méthode HTTP (Method=), en-tête (Header=)… Plusieurs predicates sur une même route sont combinés en ET.

Filter (GatewayFilter)

Transformation appliquée à la requête et/ou à la réponse d'une route qui correspond : ajouter un en-tête (AddRequestHeader), retirer un segment de chemin (StripPrefix), limiter le débit (RequestRateLimiter)… Se distingue d'un GlobalFilter, appliqué à toutes les routes.

uri: lb://

Schéma d'URI qui indique à Spring Cloud Gateway de résoudre la destination via un client de découverte de services (Eureka, par exemple) et Spring Cloud LoadBalancer, plutôt que vers une adresse fixe — lb://service-catalogue route vers une instance disponible de service-catalogue.

RequestRateLimiter

Filtre qui limite le débit de requêtes autorisées, en s'appuyant par défaut sur Redis (RedisRateLimiter, algorithme token bucket) et un KeyResolver qui détermine la clé de limitation (par utilisateur, par IP…).

TokenRelay

Filtre qui relaie le jeton d'accès OAuth2 obtenu par la gateway vers les services en aval, pour qu'ils reçoivent l'identité de l'appelant sans que la gateway rejoue une authentification séparée. Nécessite que la gateway soit elle-même configurée comme client OAuth2.

Lire l'explication détaillée et faire le quiz →

Cette page présente la partie essentielle de la leçon. Les exemples commentés, les pièges courants et les trois questions de quiz sont dans l'application.