I am using Spring Cloud Gateway and I am trying to remap a url to another one (using the SetPath filter) that uses a query string (involves a ?).
Consider the Spring Cloud Gateway config YAML below:
spring:
cloud:
gateway:
routes:
- id: demoEndpoint
uri: lb://demo-service
predicates:
- Path=/api/v1/user/{userId}/items
filters:
- SetPath=/items?searchUser={userId}
When I do a GET request on the endpoint (/api/v1/user/testUserId/items), Spring Cloud Gateway maps the request to: lb://demo-service/items but what I expected to get is lb://demo-service/items?searchUser=testUserId
It appears that Gateway has some issue when a question mark is involved in the path.
Question
How do I use query string in SetPath? Do I need to escape the ? character? Or is this a bug in Spring Cloud Gateway?
Other Info
I have tried this other config:
spring:
cloud:
gateway:
routes:
- id: demoEndpoint
uri: lb://demo-service
predicates:
- Path=/api/v1/user/{userId}/items
filters:
- SetPath=/items/searchUser={userId}
When I do a GET request on the endpoint (/api/v1/user/testUserId/items), Spring Cloud Gateway maps the request to: lb://demo-service/items/searchUser=testUserId
This helps me confirm that setPath is finding the uri segments properly (userId) and that only usage of the question mark might be causing issues.
Spring Cloud version: 2021.0.1
Spring Cloud Gateway version: 3.1.1
Related
I am building a spring cloud gateway to act as gateway with multiple backends. Some backends are internally calling websocket call ws://x.x.x.x:0000
user -> http://localhost:8085/ -> http://x.x.x.x:0000 -> ws://x.x.x.x:0000/websockify
if i don't explicitly setup a route for websocket call as well, it is taking localhost:8085 as host and port from origin server but not from http://x.x.x.x:0000.
Below is my application.yaml of spring cloud gateway and it is working. But i dont want to mention websocket_route which is being made internally from first route uri (http://x.x.x.x:0000) and i have other apps also internally making similar calls so can't setup individual routes for every app. please help
spring:
cloud:
gateway:
routes:
- id: inst-user1-target-77
uri: http://x.x.x.x:0000
predicates:
- Path=/inst-user1-target-77/**
filters:
- RewritePath=/inst-user1-target-77/(?<segment>.*), /$\{segment}
- id: websocket_route
uri: ws://x.x.x.x:0000
predicates:
- Path=/websockify
I made 2 microservices running on a cluster in Kubernetes , I was able to make an API gateway using spring cloud to call those microservices , and I made a JWT Authorization and Authentication filters in another project .
My question is, how can I integrate these filters in my API gateway to authorize the access to my microservices
spring:
cloud:
gateway:
routes:
- id: r1
uri: http://192.168.49.2:30288/
predicates:
- Path= /api1/**
- id: r2
uri: http://192.168.49.2:30289/
predicates:
- Path= /api2/**
discovery:
enabled: false
server:
port: 8888
I would like to add a path to each route that I define in spring.cloud.gateway.routes without defining context path, server.servlet.context-path, of each microservice.
E.g.: My gateway runs at port 9090, and my microservice runs at port 8071. The configuration for the microservice in the gateway is like this:
spring:
cloud:
gateway:
routes:
- id: auth
uri: 'http://localhost:8071'
If I hit http://localhost:9090/lorem/ipsum, I can ping the microservice, and see the response. But, I would like to ping the microservice from the gateway as http://localhost:9090/auth/lorem/ipsum.
If I define Path key in predicates, it pings http://localhost:8071/auth/lorem/ipsum, which fails, because the URL in the microservice is not /auth/lorem/ipsum but /lorem/ipsum.
spring:
cloud:
gateway:
routes:
- id: auth
uri: 'http://localhost:8071'
predicates:
- Path=/auth/**
Is there a way to define a path for each microservice or do I have to set server.servlet.context-path for each microservice to achieve what I would like to do?
Spring boot version: 2.6.1 & Spring cloud version: 2021.0.0
The background is my application needs to insert an user input into two databases, which are MongoDB and Elasticsearch. There are already two database-level services with save function.
Now I am working on an experiment to duplicate a single request to two downstream database services.
I have tried using Spring Cloud Gateway with routes, it can route a request to either MongoDB or Elasticsearch.
If the route to MongoDB is placed advanced of that to Elasticsearch, then Spring Cloud Gateway routes the request to MongoDB. The route to Elasticsearch is ignored even it has the same predicates with MongoDB's. And vice versa.
Here is the configuration in Yaml. Can anyone advise if duplicating a request is doable or not in Spring Cloud Gateway ? Thanks.
spring:
cloud:
gateway:
routes:
- id: http-others-route-to-mongo
uri: http://localhost:9064/
predicates:
- Path=/api/**
- Method=POST,PUT,DELETE
- Between=2020-01-15T23:59:59.000+08:00[Asia/Shanghai], 2100-12-31T23:59:59.000+08:00[Asia/Shanghai]
- id: http-others-route-to-es
uri: http://localhost:9037/
predicates:
- Path=/api/**
- Method=POST,PUT,DELETE
- Between=2020-01-15T23:59:59.000+08:00[Asia/Shanghai], 2100-12-31T23:59:59.000+08:00[Asia/Shanghai]
I have anexo API with some endpoints, like:
Localhsost:8080/api/clients -> GET findall
Localhsost:8080/api/clients/id -> GET findByID
Localhsost:8080/api/clients -> POST insert a cliente
Localhsost:8080/api/clients/id DELETE deleteByID
How do I use Spring Cloud Gateway with those endpoints?
If you're having trouble seeing where to start you could try following property-based the example from the dzone article 'Spring Cloud Gateway - Configuring a Simple Route'. You could configure just one of your services to begin with. That example suggests creating a spring cloud gateway project from the spring initializr by selecting the 'gateway' dependency and adding a route to the application.yaml:
spring:
cloud:
gateway:
routes:
- predicates:
- Path=/props/**
filters:
- StripPrefix=1
uri: "http://httpbin.org"
So you could replace httpbin.org with localhost:8080 and replace /props/** with your path - /api/clients/**. You could test that by making an http get call and then try adding in a second service afterwards. In your case I suspect you want to remove the filter to strip the prefix as it sounds like your service is exposing an /api/clients endpoint so you'd presumably want to preserve that whole path. That's something you'd need to check.