Skip to content

Commit 86b4529

Browse files
olegzspencergibb
andauthored
Add documentation for routing to functions (#3767)
* Add documentation for routing to functions This one specifically refers to using Spring Cloud Function framework Signed-off-by: Oleg Zhurakousky <ozhurakousky@vmware.com> * Update java-routes-api.adoc Signed-off-by: Spencer Gibb <sgibb@pivotal.io> --------- Signed-off-by: Oleg Zhurakousky <ozhurakousky@vmware.com> Signed-off-by: Spencer Gibb <sgibb@pivotal.io> Co-authored-by: Spencer Gibb <sgibb@pivotal.io>
1 parent 6b9e653 commit 86b4529

File tree

1 file changed

+67
-2
lines changed

1 file changed

+67
-2
lines changed

docs/modules/ROOT/pages/spring-cloud-gateway-server-webmvc/java-routes-api.adoc

Lines changed: 67 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,71 @@ class SimpleGateway {
4949
[[gateway-handlerfunctions]]
5050
== Gateway MVC Handler Functions
5151

52-
Various `RouterFunctions.Builder` methods require a `HandlerFunction<ServerResponse>`. To create a route that is proxied by the MVC Gateway, `HandlerFunction` implementations are supplied in `org.springframework.cloud.gateway.server.mvc.handler.HandlerFunctions`. The most basic is the `http()` `HandlerFunction`. The function looks for a `URI` in the `org.springframework.cloud.gateway.server.mvc.common.MvcUtils.GATEWAY_REQUEST_URL_ATTR` request attribute. This allows for dynamic targets such as load balancing to set the `URI`.
5352

54-
WARNING: As of version 4.1.7, `HandlerFunctions.http(String)` and `HandlerFunctions.http(URI)` are now deprecated. Please use `HandlerFunctions.http()` in combination with the `BeforeFilterFunctions.uri()` filter instead. This fixes inconsistencies in dealing with the route url request attribute.
53+
Various `RouterFunctions.Builder` methods require a `HandlerFunction<ServerResponse>`. To create a route that is proxied by the MVC Gateway, `HandlerFunction` implementations are supplied in `org.springframework.cloud.gateway.server.mvc.handler.HandlerFunctions`.
54+
55+
=== HTTP Handler Function
56+
The most basic handler function is `http()` `HandlerFunction`. If a `URI` is supplied as a parameter, that is the `URI` used as the downstream target for sending the HTTP requests (as seen in the example above). If no parameter is passed, the function looks for a `URI` in the `org.springframework.cloud.gateway.server.mvc.common.MvcUtils.GATEWAY_REQUEST_URL_ATTR` request attribute. This allows for dynamic targets such as load balancing to set the `URI`.
57+
58+
59+
WARNING: As of version 4.1.7, `HandlerFunctions.http(String)` and `HandlerFunctions.http(URI)` are now deprecated. Please use `HandlerFunctions.http()` in combination with the `BeforeFilterFunctions.uri()` filter instead. This fixes inconsistencies in dealing with the route url request attribute.
60+
61+
=== Spring Cloud Function Handler Function
62+
By placing https://spring.io/projects/spring-cloud-function[Spring Cloud Function] on the classpath, Spring Cloud Gateway will automatically configure routes to invoke functions you define as beans. The bean names of the functions will be used as the path of the routes.
63+
64+
For example, given the following configuration:
65+
66+
[source,xml]
67+
----
68+
<dependency>
69+
<groupId>org.springframework.cloud</groupId>
70+
<artifactId>spring-cloud-function-context</artifactId>
71+
</dependency>
72+
----
73+
74+
Once Spring Cloud Function dependency is provided the name of the Java function bean becomes the path you can use to route to functions.
75+
76+
For example, assume the following application:
77+
78+
[source,java]
79+
----
80+
@SpringBootApplication
81+
public class DemoFunctionGatewayApplication {
82+
83+
public static void main(String[] args) {
84+
SpringApplication.run(DemoFunctionGatewayApplication.class, args);
85+
}
86+
87+
88+
@Bean
89+
public Function<String, String> uppercase() {
90+
return v -> v.toUpperCase();
91+
}
92+
93+
@Bean
94+
public Function<String, String> concat() {
95+
return v -> v + v;
96+
}
97+
}
98+
----
99+
You can invoke the `concat` or `uppercase` functions by issuing a `GET` or `POST` request to `/concat` or `/uppercase`.
100+
101+
Making a `GET` request to ``http://localhost:8080/uppercase/hello` will invoke the `uppercase` function with the String `hello` and return `HELLO` in the `GET` response body.
102+
103+
Instead of passing the function parameter as a path parameter you can use a `POST` request. For example the following cURL command can issued to invoke the `concat` function:
104+
105+
[source,bash]
106+
----
107+
$ curl -d ‘"hello"' -H "Content-Type: application/json" -X POST http://localhost:8080/concat
108+
----
109+
110+
The response body will contain `hellohello`.
111+
112+
Spring Cloud Gateway also supports function composition by issuing a request to a path composed of function names separated by a comma. For example:
113+
114+
[source,bash]
115+
----
116+
$ curl -d ‘"hello"' -H "Content-Type: application/json" -X POST http://localhost:8080/concat,uppercase
117+
----
118+
119+
The response body will contain `HELLOHELLO`.

0 commit comments

Comments
 (0)