doc: Document how to retrieve RouteMatch (#10493)

src/main/docs/guide/httpServer/routing.adoc

@@ -197,3 +197,11 @@ String lock(String name)
 ----
 
 The annotation can be used anywhere the standard method annotations can be used, including controllers and declarative HTTP clients.
+
+== RouteMatch
+
+The api:web.router.RouteMatch[] API provides information about an executable api:web.router.Route[].
+
+Given a request you can retrieve a RouteMatch with:
+
+snippet::io.micronaut.docs.web.router.routematch.RouteMatchTest[tags="routematch", indent=0]

test-suite-groovy/src/test/groovy/io/micronaut/docs/web/router/routematch/RouteMatchTest.groovy

@@ -0,0 +1,49 @@
+package io.micronaut.docs.web.router.routematch
+
+import io.micronaut.context.annotation.Property
+import io.micronaut.context.annotation.Requires
+import io.micronaut.http.HttpAttributes
+import io.micronaut.http.HttpRequest
+import io.micronaut.http.MediaType
+import io.micronaut.http.annotation.Controller
+import io.micronaut.http.annotation.Get
+import io.micronaut.http.annotation.Produces
+import io.micronaut.http.client.BlockingHttpClient
+import io.micronaut.http.client.HttpClient
+import io.micronaut.http.client.annotation.Client
+import io.micronaut.test.extensions.spock.annotation.MicronautTest
+import io.micronaut.web.router.RouteMatch
+import jakarta.inject.Inject
+import spock.lang.Specification
+
+@Property(name = "spec.name", value = "RouteMatchSpec")
+@MicronautTest
+class RouteMatchTest extends Specification {
+
+ @Inject
+ @Client("/")
+ HttpClient httpClient
+
+ void testRouteMatchRetrieval() {
+ given:
+ BlockingHttpClient client = httpClient.toBlocking()
+
+ expect:
+ "text/plain" == client.retrieve(HttpRequest.GET("/routeMatch").accept(MediaType.TEXT_PLAIN), String)
+ }
+
+ @Requires(property = "spec.name", value = "RouteMatchSpec")
+ @Controller
+ static class RouteMatchController {
+
+ @Produces(MediaType.TEXT_PLAIN)
+ @Get("/routeMatch")
+//tag::routematch[]
+ String index(HttpRequest<?> request) {
+ RouteMatch<?> routeMatch = request.getAttribute(HttpAttributes.ROUTE_MATCH, RouteMatch.class)
+ .orElse(null)
+//end::routematch[]
+ return routeMatch != null ? routeMatch.getRouteInfo().getProduces().stream().map(MediaType::toString).findFirst().orElse(null) : null
+ }
+ }
+}

test-suite-kotlin/src/test/kotlin/io/micronaut/docs/web/router/routematch/RouteMatchTest.kt

@@ -0,0 +1,40 @@
+package io.micronaut.docs.web.router.routematch
+
+import io.micronaut.context.annotation.Property
+import io.micronaut.context.annotation.Requires
+import io.micronaut.http.HttpAttributes
+import io.micronaut.http.HttpRequest
+import io.micronaut.http.MediaType
+import io.micronaut.http.annotation.Controller
+import io.micronaut.http.annotation.Get
+import io.micronaut.http.annotation.Produces
+import io.micronaut.http.client.HttpClient
+import io.micronaut.http.client.annotation.Client
+import io.micronaut.test.extensions.junit5.annotation.MicronautTest
+import io.micronaut.web.router.RouteMatch
+import org.junit.jupiter.api.Assertions.*
+import org.junit.jupiter.api.Test
+
+@Property(name = "spec.name", value = "RouteMatchSpec")
+@MicronautTest
+internal class RouteMatchTest {
+ @Test
+ fun testRouteMatchRetrieval(@Client("/") httpClient: HttpClient) {
+ val client = httpClient.toBlocking()
+ assertEquals("text/plain", client.retrieve(HttpRequest.GET<Any>("/routeMatch").accept(MediaType.TEXT_PLAIN), String::class.java))
+ }
+
+ @Requires(property = "spec.name", value = "RouteMatchSpec")
+ @Controller
+ internal class RouteMatchController {
+ @Produces(MediaType.TEXT_PLAIN)
+ @Get("/routeMatch")
+//tag::routematch[]
+ fun index(request: HttpRequest<*>): String? {
+ val routeMatch = request.getAttribute(HttpAttributes.ROUTE_MATCH, RouteMatch::class.java)
+ .orElse(null)
+//end::routematch[]
+ return routeMatch?.routeInfo?.produces?.stream()?.map { obj: MediaType -> obj.toString() }?.findFirst()?.orElse(null)
+ }
+ }
+}

test-suite/src/test/java/io/micronaut/docs/web/router/routematch/RouteMatchTest.java

@@ -0,0 +1,44 @@
+package io.micronaut.docs.web.router.routematch;
+
+import io.micronaut.context.annotation.Property;
+import io.micronaut.context.annotation.Requires;
+import io.micronaut.http.HttpAttributes;
+import io.micronaut.http.HttpRequest;
+import io.micronaut.http.MediaType;
+import io.micronaut.http.annotation.Controller;
+import io.micronaut.http.annotation.Get;
+import io.micronaut.http.annotation.Produces;
+import io.micronaut.http.client.BlockingHttpClient;
+import io.micronaut.http.client.HttpClient;
+import io.micronaut.http.client.annotation.Client;
+import io.micronaut.test.extensions.junit5.annotation.MicronautTest;
+import io.micronaut.web.router.RouteMatch;
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+@Property(name = "spec.name", value = "RouteMatchSpec")
+@MicronautTest
+class RouteMatchTest {
+
+ @Test
+ void testRouteMatchRetrieval(@Client("/")HttpClient httpClient) {
+ BlockingHttpClient client = httpClient.toBlocking();
+ assertEquals("text/plain", client.retrieve(HttpRequest.GET("/routeMatch").accept(MediaType.TEXT_PLAIN), String.class));
+ }
+
+ @Requires(property = "spec.name", value = "RouteMatchSpec")
+ @Controller
+ static class RouteMatchController {
+
+ @Produces(MediaType.TEXT_PLAIN)
+ @Get("/routeMatch")
+//tag::routematch[]
+ String index(HttpRequest<?> request) {
+ RouteMatch<?> routeMatch = request.getAttribute(HttpAttributes.ROUTE_MATCH, RouteMatch.class)
+ .orElse(null);
+//end::routematch[]
+ return routeMatch != null ? routeMatch.getRouteInfo().getProduces().stream().map(MediaType::toString).findFirst().orElse(null) : null;
+ }
+ }
+}