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

Integrating with Eureka/Consul

Configure Spring Cloud Gateway to register with and discover services from a service registry like Eureka or Consul.

Integrating with Eureka/Consul is a free API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) lesson on CoddyKit — lesson 1 of 4. You can read the complete lesson below for free — then practise it hands-on in the browser with a built-in code editor and a 24/7 AI tutor. It is part of the API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) learning path, one of 4 lessons in the course, and your progress syncs across the web and the CoddyKit app.

What is Service Discovery?

In a microservices architecture, services are often dynamic. They can scale up or down, and their network locations (IP addresses, ports) can change frequently.

Service discovery is a mechanism that helps applications and services find each other without needing to hardcode their network locations. It's like a dynamic phone book for your services!

Service Registries: Eureka & Consul

A service registry is a central server that maintains a list of available service instances and their network locations.

  • Netflix Eureka: A very popular choice, especially within the Spring Cloud ecosystem. Services register themselves with Eureka.
  • HashiCorp Consul: Another robust option, offering service discovery along with a distributed key-value store and health checks.

Both allow services to register themselves and discover others.

Gateway's Need for Discovery

Spring Cloud Gateway acts as the entry point to your microservices.

Instead of configuring routes with fixed URLs for each backend service, the Gateway can query a service registry:

  • "Where is the 'user-service' running right now?"
  • "Give me an available instance of 'product-service'."

This enables flexible, dynamic, and resilient routing, as the Gateway doesn't need to know service locations upfront.

Sample Service: Eureka Client Config

First, let's look at how a simple Spring Boot service is configured to register itself with a Eureka server.

We'll use a service named hello-service. Its application.yml will point to the Eureka server's default zone.

spring:
  application:
    name: hello-service
server:
  port: 8081
eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8761/eureka

Enabling Eureka Client in Service

To make our hello-service actually register with Eureka, we need to add the @EnableEurekaClient annotation to its main application class.

This annotation activates the Eureka Discovery Client functionality.

package com.example.helloservice;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@EnableEurekaClient
@SpringBootApplication
@RestController
public class HelloServiceApplication {

    public static void main(String[] args) {
        SpringApplication.run(HelloServiceApplication.class, args);
    }

    @GetMapping("/hello")
    public String hello() {
        return "Hello from Hello Service!";
    }
}

Gateway Configuration for Eureka

Now, let's configure our Spring Cloud Gateway to connect to the same Eureka server. The Gateway itself also acts as a Eureka client to discover other services.

Its application.yml will specify the Eureka server URL and its own application name.

server:
  port: 8080
eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8761/eureka
  instance:
    hostname: localhost
spring:
  application:
    name: api-gateway

Enabling Discovery in Gateway

Similar to the backend service, the Gateway's main application class needs an annotation to enable its discovery capabilities.

Use @EnableDiscoveryClient to tell Spring Boot to activate the discovery client for the Gateway.

package com.example.apigateway;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;

@EnableDiscoveryClient
@SpringBootApplication
public class ApiGatewayApplication {

    public static void main(String[] args) {
        SpringApplication.run(ApiGatewayApplication.class, args);
    }
}

Routing via Service ID

With discovery enabled, we can define Gateway routes using a service's registered ID instead of a fixed URL.

The lb:// prefix (for 'load balancer') tells the Gateway to use its discovery client to find instances of the specified service name (e.g., hello-service) and then route the request.

spring:
  cloud:
    gateway:
      routes:
        - id: hello_route
          uri: lb://hello-service
          predicates:
            - Path=/hello/**

The Request Flow

Let's trace a request to http://localhost:8080/hello:

  1. The Gateway (listening on port 8080) receives the request.
  2. It matches the /hello/** path predicate to the hello_route.
  3. The Gateway uses its Eureka client to look up an available instance of hello-service.
  4. Eureka returns the address of an instance (e.g., localhost:8081).
  5. The Gateway forwards the request to http://localhost:8081/hello.
  6. The hello-service processes the request and returns a response, which the Gateway then sends back to the client.

Consul: Another Option

While Eureka is widely used, Consul by HashiCorp is another powerful service discovery and configuration management tool.

To use Consul, you'd typically add the Spring Cloud Consul Discovery dependency and configure your Gateway/services to point to the Consul agent (usually running on port 8500).

The principle remains the same: the Gateway uses service IDs (e.g., lb://my-service) to dynamically discover and route to services registered in Consul.

spring:
  cloud:
    consul:
      host: localhost
      port: 8500
      discovery:
        service-name: api-gateway

Gateway Discovery Check

You've configured your Spring Cloud Gateway to use Eureka for service discovery, and you have a service named my-service registered in Eureka.

Which uri configuration would correctly route requests to my-service via discovery?

Lesson Summary

In this lesson, you learned about:

  • The importance of service discovery in dynamic microservice environments.
  • How Eureka and Consul serve as central service registries.
  • Configuring both backend services and Spring Cloud Gateway as discovery clients.
  • Defining Gateway routes using service IDs (e.g., lb://service-name) for dynamic routing.

This integration is fundamental for building scalable and resilient microservice architectures. Next, we'll explore more dynamic routing rules and predicates.

Frequently asked questions

Is the “Integrating with Eureka/Consul” lesson free?

Yes — the full text of “Integrating with Eureka/Consul” is free to read here on the web, and the API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) course includes 4 lessons in total. To practise it interactively (a built-in code editor and a 24/7 AI tutor) and unlock the rest of the API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) course, upgrade to CoddyKit PRO.

What will I learn in “Integrating with Eureka/Consul”?

Configure Spring Cloud Gateway to register with and discover services from a service registry like Eureka or Consul. You practise API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) with hands-on code you run directly in the browser, and a 24/7 AI tutor answers your questions as you work through the lesson.

Do I need any experience to start API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)?

No prior experience is required. API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) on CoddyKit is structured for beginners through advanced learners; this is — lesson 1 of 4, so you can start here or from the beginning and move at your own pace.

How long does the “Integrating with Eureka/Consul” lesson take?

Most CoddyKit lessons take about 5–10 minutes. Each one is bite-sized and interactive, so you make steady progress and pick up exactly where you left off across the web and the app.

Can I write and run code in this API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) lesson?

Yes. Every API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) lesson includes a built-in code editor, so you write and run real code right in your browser and get instant AI feedback — no local setup required.

All lessons in this course

  1. Integrating with Eureka/Consul
  2. Dynamic Routing with Service Discovery
  3. Load Balancing with Spring Cloud LoadBalancer
  4. The lb:// URI & Discovery Locator
← Back to API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)