Document LocalTestWebServer

Closes gh-48333

Author: snicoll

documentation/spring-boot-docs/src/docs/antora/modules/how-to/pages/webserver.adoc

@@ -165,6 +165,19 @@ Contrary to a test, application code callbacks are processed early (before the v
 
 
 
+[[howto.webserver.build-uri-test-web-server]]
+== Build URI Against the Test Web Server
+
+Tests that start a javadoc:org.springframework.boot.web.server.WebServer[] such as  `@SpringBootTest(webEnvironment=WebEnvironment.RANDOM_PORT)` can get information about
+the running server using javadoc:org.springframework.boot.test.http.server.LocalTestWebServer[], as shown in the following example:
+
+include-code::MyWebIntegrationTests[]
+
+javadoc:org.springframework.boot.test.http.server.LocalTestWebServer[] provides access to a suitable javadoc:org.springframework.web.util.UriBuilderFactory[].
+It can also be customized to build such an instance on a sub-path of your application.
+
+
+
 [[howto.webserver.enable-response-compression]]
 == Enable HTTP Response Compression
 

documentation/spring-boot-docs/src/main/java/org/springframework/boot/docs/howto/webserver/builduritestwebserver/MyWebIntegrationTests.java

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2012-present the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.boot.docs.howto.webserver.builduritestwebserver;
+
+import org.junit.jupiter.api.Test;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
+import org.springframework.boot.test.http.server.LocalTestWebServer;
+import org.springframework.context.ApplicationContext;
+
+@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
+class MyWebIntegrationTests {
+
+	@Autowired
+	ApplicationContext context;
+
+	// ...
+
+	@Test
+	void test() {
+		String urlToTest = LocalTestWebServer.obtain(this.context).uri("/test");
+	}
+
+}

documentation/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/howto/webserver/builduritestwebserver/MyWebIntegrationTests.kt

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2012-present the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.boot.docs.howto.webserver.builduritestwebserver
+
+import org.junit.jupiter.api.Test
+import org.springframework.beans.factory.annotation.Autowired
+import org.springframework.boot.test.context.SpringBootTest
+import org.springframework.boot.test.context.SpringBootTest.WebEnvironment
+import org.springframework.boot.test.http.server.LocalTestWebServer
+import org.springframework.context.ApplicationContext
+
+@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
+class MyWebIntegrationTests(@Autowired val context: ApplicationContext) {
+
+	// ...
+
+	@Test
+	fun test() {
+		val urlToTest = LocalTestWebServer.obtain(this.context).uri("/test")
+	}
+
+}
+