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, Jan 27 '21 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, Jan 27 '22 at 20:01

score 7 · Answer 1 · edited Jan 18 '21 at 15:01

7

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

edited Jan 18 '21 at 15:01

troy

2,145
2
23
31

answered Jan 18 '21 at 06:58

Shubham Chinchure

79
2

Can you explain why this works? And what was wrong before? – Eric Huang Oct 26 '21 at 09:23
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 ? – Bigyan Devkota Mar 06 '22 at 23:11

score 3 · Accepted Answer · answered Dec 17 '20 at 04:46

3

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 '20 at 04:46

arj

887
1
15
37

7

You simply removed the loadbalancing – Muhammed Ozdogan May 02 '21 at 21:57
6

your totally killed the purpose of microservices, by removing load balancing. – Muhammad Adnan Jul 16 '21 at 01:56

score 3 · Answer 3 · edited Nov 26 '22 at 12:36

3

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 '22 at 12:36

Stephen Ostermiller

23,933
14
88
109

answered Apr 05 '22 at 15:48

Abdelrahman Elayashy

530
4
14

the above bean should be added to the API gate way and all will be fine. – Odwori Nov 25 '22 at 17:04

score 1 · Answer 4 · edited Nov 02 '21 at 09:48

1

Add in your application.properties:

spring.cloud.discovery.enabled=true

edited Nov 02 '21 at 09:48

Dmitry Rakovets

557
1
6
15

answered Apr 13 '21 at 04:52

user15618336

11
1

Cyril Sojan · Answer 5 · 2021-05-10T11:02:54.710

1

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 '21 at 11:02

answered May 06 '21 at 11:51

Cyril Sojan

149
7

score 1 · Answer 6 · edited Nov 01 '21 at 05:33

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.

score 1 · Answer 7 · answered May 15 '22 at 01:19

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**

score 1 · Answer 8 · answered Jul 21 '22 at 07:22

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.

score 0 · Answer 9 · answered Dec 25 '20 at 14:41

0

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

answered Dec 25 '20 at 14:41

ilham kh

21
1

I have the same issue – the_tourist Jan 12 '21 at 14:59

score 0 · Answer 10 · answered Jan 26 '21 at 03:56

0

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 '21 at 03:56

gourav kumar

1

score 0 · Answer 11 · answered Feb 27 '21 at 11:07

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

score 0 · Answer 12 · answered May 26 '21 at 04:12

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 '21 at 04:12

Ravindra

51
5

score 0 · Answer 13 · answered Jan 28 '22 at 22:12

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

Spring Cloud API Gateway routing not working

13 Answers13

Linked