Spring Cloud API Gateway routing not working

Question

I have designed a micro service prototype using below technologies

Eureka Server
a service
Spring Cloud API Gateway

Above mentioned service are registered in the Eureka Server

API Gateway routing Configuration

server.port=8080
eureka.client.serviceUrl.defaultZone = http://localhost:8083/eureka
spring.application.name=ApiGateway
spring.cloud.gateway.discovery.locator.enabled=true
spring.cloud.gateway.discovery.locator.lower-case-service-id=true

spring.cloud.gateway.routes[0].id=service1
spring.cloud.gateway.routes[0].uri=lb://MICROSERVICE1
spring.cloud.gateway.routes[0].predicates[0]=Path=/service1/**

The service Configuration

server.port=8081
server.address=127.0.0.1
eureka.client.serviceUrl.defaultZone = http://localhost:8083/eureka
spring.application.name=MicroService1
error.whitelabel.enabled= false

Controller

@RestController
@RequestMapping("/service1")
public class HomeController {
    @GetMapping("/message")
    public String hello() {
        return "response from micro service1";
    }

}

When I send a request to the gateway it's showing the below error

2020-12-16 22:26:09.770 ERROR 16700 --- [ctor-http-nio-3] a.w.r.e.AbstractErrorWebExceptionHandler : [d3334561-1]  500 Server Error for HTTP GET "/service1/message"

java.net.UnknownHostException: failed to resolve 'LAPTOP-KU56B6A8' after 3 queries 
    at io.netty.resolver.dns.DnsResolveContext.finishResolve(DnsResolveContext.java:1013) ~[netty-resolver-dns-4.1.55.Final.jar:4.1.55.Final]
    Suppressed: reactor.core.publisher.FluxOnAssembly$OnAssemblyException: 
Error has been observed at the following site(s):
    |_ checkpoint ⇢ org.springframework.cloud.gateway.filter.WeightCalculatorWebFilter [DefaultWebFilterChain]
    |_ checkpoint ⇢ HTTP GET "/service1/message" [ExceptionHandlingWebHandler]

How can we solve the above issue?

Add : eureka.instance.prefer-ip-address=true to application.properties file to all your microservices & api-gateway — Vipul Gupta
– Vipul Gupta, Commented Jan 27, 2021 at 13:44
In your Service Configuration, you have set the application name as MicroService1 but have set the id as service1 in API Gateway Routing Configuration. Also, your uri is set as MICROSERVICE1. All 3 different, why? Put the id and uri to MicroService1 as the application name is being registered with it only. See if it helps! — Superman
– Superman, Commented Jan 27, 2022 at 20:01

troy · Accepted Answer · 2021-01-18 15:01:50Z

8

Add eureka.instance.hostname=localhost in both the microservices instances this will work and not give an error

edited Jan 18, 2021 at 15:01

troy

2,5453 gold badges28 silver badges32 bronze badges

answered Jan 18, 2021 at 6:58

Shubham Chinchure

892 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Eric Huang Over a year ago

Can you explain why this works? And what was wrong before?

Bigyan Devkota Over a year ago

ran into the same issue, this works like a charm, not sure why though lol maybe API gateway doesn't recognize the localhost until you explicitly specify it ?

arj · Accepted Answer · 2020-12-17 04:46:11Z

4

i have modified the API Gate Way routing Configuration like below

spring.cloud.gateway.routes[0].id=service1
spring.cloud.gateway.routes[0].uri=http://localhost:8081/service1/
spring.cloud.gateway.routes[0].predicates[0]=Path=/service1/**

Now is working fine

answered Dec 17, 2020 at 4:46

arj

1,0031 gold badge19 silver badges48 bronze badges

2 Comments

Muhammed Ozdogan Over a year ago

You simply removed the loadbalancing

Muhammad Adnan Over a year ago

your totally killed the purpose of microservices, by removing load balancing.

Stephen Ostermiller · Accepted Answer · 2022-11-26 12:36:04Z

4

Add this bean in your API gateway and you are good to go.

@Bean
public HttpClient httpClient() {
    return HttpClient.create().resolver(DefaultAddressResolverGroup.INSTANCE);
}

edited Nov 26, 2022 at 12:36

Stephen Ostermiller♦

25.8k18 gold badges96 silver badges117 bronze badges

answered Apr 5, 2022 at 15:48

Abdelrahman Elayashy

5984 silver badges14 bronze badges

1 Comment

Odwori Over a year ago

the above bean should be added to the API gate way and all will be fine.

Yehdhih ANNA · Accepted Answer · 2024-02-27 11:45:51Z

4

Check your pom.xml file, depending on the version of the dependencies with which the project got initialized there is a slight chance that you have :

<dependency>
   <groupId>org.springframework.cloud</groupId>
   <artifactId>spring-cloud-starter-gateway-mvc</artifactId>
</dependency>

instead of :

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>

notice that in the first it is using spring-cloud-starter-gateway-mvc instead of the bare spring-cloud-starter-gateway

correct it and hopefully it might fix it for you.

answered Feb 27, 2024 at 11:45

Yehdhih ANNA

1,3201 gold badge14 silver badges23 bronze badges

Comments

Abhishek kumar · Accepted Answer · 2024-04-18 21:09:02Z

4

Please check your dependency like the below

org.springframework.cloud

spring-cloud-starter-gateway

it should not contain like below

org.springframework.cloud

spring-cloud-starter-gateway-mvc

Please remove -mvc from dependency.

answered Apr 18, 2024 at 21:09

Abhishek kumar

536 bronze badges

2 Comments

Hola Soy Edu Feliz Navidad Over a year ago

The wost part of your answer is that it is 100% right. I don't know why the initializr add -mvc.

nerdherd Apr 10 at 19:04

Note that spring-cloud-starter-gateway is the reactive gateway, and spring-cloud-starter-gateway-mvc is the newer non-reactive gateway. They are closely related but two totally separate frameworks.

Dmitry Rakovets · Accepted Answer · 2021-11-02 09:48:50Z

3

Add in your application.properties:

spring.cloud.discovery.enabled=true

edited Nov 2, 2021 at 9:48

Dmitry Rakovets

5891 gold badge6 silver badges15 bronze badges

answered Apr 13, 2021 at 4:52

user15618336

311 bronze badge

Comments

Cyril Sojan · Accepted Answer · 2021-05-10 11:02:54Z

2

Add below to both gateway and individual microservice fix the issue

eureka.instance.hostname=localhost
eureka.client.serviceUrl.defaultZone=http://${eureka.instance.hostname}:8010/eureka/

edited May 10, 2021 at 11:02

answered May 6, 2021 at 11:51

Cyril Sojan

1797 bronze badges

Comments

Dmitry Rakovets · Accepted Answer · 2021-11-01 05:33:59Z

2

You can add the following in application.yml file

spring:
  cloud:
    gateway:
      routes:
        - id: test-service
          uri: lb://MICROSERVICE1
          predicates:
            - Path=/microservice1/**
          filters:
            - RewritePath=/microservice1/(?<segment>.*), /$\{segment}

with this it should works.

Like let say if your microservice1 is url is localhost:8081/service1/message then you can define the base path of your microservice1 in api-gateway by setting up the path as i did in above configuration.

edited Nov 1, 2021 at 5:33

Dmitry Rakovets

5891 gold badge6 silver badges15 bronze badges

answered Jul 27, 2021 at 12:53

Raj Hirani

1922 silver badges6 bronze badges

Comments

nonder · Accepted Answer · 2022-07-21 07:22:44Z

2

This is the only solution works among all of the answers above.

@Bean
public HttpClient httpClient() {
    return HttpClient.create().resolver(DefaultAddressResolverGroup.INSTANCE);
}

This is the default behavior, so no effect.

spring.cloud.discovery.enabled=true

This has nothing to do with the discovery client. It is related with the discovery server.

eureka.instance.hostname=localhost

So if you don't know, just don't mess it up with wrong directions.

answered Jul 21, 2022 at 7:22

nonder

1551 silver badge10 bronze badges

Comments

ilham kh · Accepted Answer · 2020-12-25 14:41:07Z

1

hello jebji if you still have this problem add spring.cloud.discovery.enabled=true in application.properties

answered Dec 25, 2020 at 14:41

ilham kh

411 bronze badge

1 Comment

kasualnetuser Over a year ago

I have the same issue

gourav kumar · Accepted Answer · 2021-01-26 03:56:03Z

1

Only Add the following property into your API gateway:

spring.cloud.discovery.enabled=true

Make sure you already added DevTool maven dependency into your API gateway project but if not then restart it.

answered Jan 26, 2021 at 3:56

gourav kumar

111 bronze badge

Comments

shrawan tiwari · Accepted Answer · 2021-02-27 11:07:43Z

1

add flowing property in application.property file of all eruka client microservice and api gateway , i face same issue and resolve doing same activity

spring.cloud.discovery.enabled=true
spring.cloud.gateway.discovery.locator.lower-case-service-id= true
spring.cloud.gateway.discovery.locator.enabled= true
eureka.instance.hostname=localhost

answered Feb 27, 2021 at 11:07

shrawan tiwari

295 bronze badges

Comments

Ankit pathak · Accepted Answer · 2022-05-15 01:19:31Z

1

I have modified my .yaml file with this configuration. Issue resolved for me.

**server:
  port: 9999
spring:
  application:
    name: gateway-ws
  cloud:
    gateway:
      discovery:
        locator:
          enabled: true
      routes:
      - id: userService
        uri: http://user-service/
        predicates:
        - Path=/user/**
      - id: contactService
        uri: http://contact-service/
        predicates:
        - Path=/contact/**
        
        
eureka:
  client:
    service-url:
       defaultZone: http://localhost:8085/eureka**

answered May 15, 2022 at 1:19

Ankit pathak

111 bronze badge

Comments

Ravindra · Accepted Answer · 2021-05-26 04:12:36Z

0

after adding all the above properties then also if you are facing issue then try the below one,

don't use lb://albums_service , but use lb://albums-service .Because URI don‘t support underline.

answered May 26, 2021 at 4:12

Ravindra

711 silver badge5 bronze badges

Comments

aminator · Accepted Answer · 2022-01-28 22:12:09Z

0

The error message is "failed to resolve 'LAPTOP-KU56B6A8'".

This is an DNS issue.

You can set eureka.instance.prefer-ip-address=true in the service.

So it will register with its ip at Eureka and the DNS issue can be avoided.

This is actually the same issue as this QUESTION.

With this ANSWER

answered Jan 28, 2022 at 22:12

aminator

5219 silver badges23 bronze badges

Comments

Jolly Good · Accepted Answer · 2023-10-06 17:06:52Z

0

For anyone else who's coming here and not using Eureka; In my case I was using Docker and I've specified docker service name instead of localhost in the routes config! (and vice versa). Also putting this here because I am making this mistake twice and if I need to remind myself again :) (Or maybe we can define this for different environments I guess.) For example:

uri: http://commit-tracker:8081

to

 uri: http://localhost:8081

answered Oct 6, 2023 at 17:06

Jolly Good

6109 silver badges22 bronze badges

Comments

sparsh610 · Accepted Answer · 2024-03-03 04:21:43Z

0

I was also facing same issue

I am using

spring.cloud.gateway.discovery.locator.enabled=true

in gateway.

springboot version : 3.2.3

answered Mar 3, 2024 at 4:21

sparsh610

1,6014 gold badges29 silver badges72 bronze badges

Comments

Baidyanath · Accepted Answer · 2024-04-06 17:12:28Z

0

Please use spring-boot-starter-webflux and spring-cloud-starter-gateway dependency. It worked for me

answered Apr 6, 2024 at 17:12

Baidyanath

192 bronze badges

1 Comment

Hola Soy Edu Feliz Navidad Over a year ago

With only spring-cloud-starter-gateway is enough

Collectives™ on Stack Overflow

Spring Cloud API Gateway routing not working

18 Answers 18

2 Comments

2 Comments

1 Comment

Comments

2 Comments

Comments

Comments

Comments

Comments

1 Comment

Comments

Comments

Comments

Comments

Comments

Comments

Comments

1 Comment

Linked

Hot Network Questions

Collectives™ on Stack Overflow

18 Answers 18

2 Comments

2 Comments

1 Comment

Comments

2 Comments

Comments

Comments

Comments

Comments

1 Comment

Comments

Comments

Comments

Comments

Comments

Comments

Comments

1 Comment

Linked

Related