Added map property to set custom headers Fixes #144

Author: bnasslahsen

README.md

@@ -86,19 +86,24 @@ openApi {
 	customBootRun {
 		args.set(["--spring.profiles.active=special"])
 	}
+	requestHeaders = [
+		"x-forwarded-host": "custom-host",
+	"x-forwarded-port": "7000"
+	]
 }
 ```
 
 | Parameter            | Description                                                                                                                         | Required | Default                              |
 |----------------------|-------------------------------------------------------------------------------------------------------------------------------------|----------|--------------------------------------|
-| `apiDocsUrl`         | The URL from where the OpenAPI doc can be downloaded. If the url ends with `.yaml`, output will YAML format.                        | No       | http://localhost:8080/v3/api-docs    |
+| `apiDocsUrl`         | The URL from where the OpenAPI doc can be downloaded. If the url ends with `.yaml`, output will YAML format.                                                                                 | No       | http://localhost:8080/v3/api-docs    |
 | `outputDir`          | The output directory for the generated OpenAPI file                                                                                 | No       | $buildDir - Your project's build dir |
-| `outputFileName`     | Specifies the output file name.                                                                                                     | No       | openapi.json                         |
+| `outputFileName`     | Specifies the output file name.                            | No       | openapi.json                         |
 | `waitTimeInSeconds`  | Time to wait in seconds for your Spring Boot application to start, before we make calls to `apiDocsUrl` to download the OpenAPI doc | No       | 30 seconds                           |
 | `trustStore`         | Path to a trust store that contains custom trusted certificates.                                                                    | No       | `<None>`                             |
 | `trustStorePassword` | Password to open Trust Store                                                                                                        | No       | `<None>`                             |
 | `groupedApiMappings` | A map of URLs (from where the OpenAPI docs can be downloaded) to output file names                                                  | No       | []                                   |
 | `customBootRun`      | Any bootRun property that you would normal need to start your spring boot application.                                              | No       | (N/A)                                |
+| `requestHeaders`     | customize Generated server url, relies on `server.forward-headers-strategy=framework`                                      | No       | (N/A)                                |
 
 ### `customBootRun` properties examples
 
@@ -178,7 +183,7 @@ OpenAPI doc.
    in `build.gradle.kts`
 
     ```
-    id("org.springdoc.openapi-gradle-plugin") version "1.9.0"
+    id("org.springdoc.openapi-gradle-plugin") version "1.8.0"
     ```
 
 3. Add the following to the spring boot apps `settings.gradle`
@@ -197,4 +202,4 @@ OpenAPI doc.
 * Thanks a lot [JetBrains](https://www.jetbrains.com/?from=springdoc-openapi) for
   supporting springdoc-openapi project.
 
-![JetBrains logo](https://springdoc.org/img/jetbrains.svg)
+![JetBrains logo](https://springdoc.org/img/jetbrains.svg)

src/main/kotlin/org/springdoc/openapi/gradle/plugin/OpenApiExtension.kt

@@ -23,6 +23,8 @@ open class OpenApiExtension @Inject constructor(
 
 	val groupedApiMappings: MapProperty<String, String> =
 		objects.mapProperty(String::class.java, String::class.java)
+	val requestHeaders: MapProperty<String, String> =
+		objects.mapProperty(String::class.java, String::class.java)
 	val customBootRun: CustomBootRunAction =
 		objects.newInstance(CustomBootRunAction::class.java)
 

src/main/kotlin/org/springdoc/openapi/gradle/plugin/OpenApiGeneratorTask.kt

@@ -44,7 +44,12 @@ open class OpenApiGeneratorTask : DefaultTask() {
 	val outputFileName: Property<String> = project.objects.property(String::class.java)
 
 	@get:Input
-	val groupedApiMappings: MapProperty<String, String> = project.objects.mapProperty(String::class.java, String::class.java)
+	val groupedApiMappings: MapProperty<String, String> =
+		project.objects.mapProperty(String::class.java, String::class.java)
+
+	@get:Input
+	val requestHeaders: MapProperty<String, String> =
+		project.objects.mapProperty(String::class.java, String::class.java)
 
 	@get:OutputDirectory
 	val outputDir: DirectoryProperty = project.objects.directoryProperty()
@@ -74,6 +79,7 @@ open class OpenApiGeneratorTask : DefaultTask() {
 		waitTimeInSeconds.convention(extension.waitTimeInSeconds)
 		trustStore.convention(extension.trustStore)
 		trustStorePassword.convention(extension.trustStorePassword)
+		requestHeaders.convention(extension.requestHeaders)
 	}
 
 	@TaskAction
@@ -97,16 +103,23 @@ open class OpenApiGeneratorTask : DefaultTask() {
 				val connection: HttpURLConnection =
 					URL(url).openConnection() as HttpURLConnection
 				connection.requestMethod = "GET"
+				requestHeaders.get().forEach { header ->
+					connection.setRequestProperty(header.key, header.value)
+				}
+
 				connection.connect()
 				val statusCode = connection.responseCode
-				logger.debug("apiDocsUrl = {} status code = {}", url, statusCode)
+				logger.trace("apiDocsUrl = {} status code = {}", url, statusCode)
 				statusCode < MAX_HTTP_STATUS_CODE
 			}
 			logger.info("Generating OpenApi Docs..")
 			HttpsURLConnection.setDefaultSSLSocketFactory(sslContext.socketFactory)
 			val connection: HttpURLConnection =
 				URL(url).openConnection() as HttpURLConnection
 			connection.requestMethod = "GET"
+			requestHeaders.get().forEach { header ->
+				connection.setRequestProperty(header.key, header.value)
+			}
 			connection.connect()
 
 			val response = String(connection.inputStream.readBytes(), Charsets.UTF_8)

src/test/kotlin/org/springdoc/openapi/gradle/plugin/OpenApiGradlePluginTest.kt

@@ -1,5 +1,6 @@
 package org.springdoc.openapi.gradle.plugin
 
+import com.beust.klaxon.JsonArray
 import com.beust.klaxon.JsonObject
 import com.beust.klaxon.Parser
 import com.fasterxml.jackson.databind.ObjectMapper
@@ -12,6 +13,7 @@ import org.gradle.testkit.runner.TaskOutcome
 import org.junit.jupiter.api.Assertions.assertEquals
 import org.junit.jupiter.api.Assertions.assertFalse
 import org.junit.jupiter.api.Assertions.assertNotNull
+import org.junit.jupiter.api.Assertions.assertTrue
 import org.junit.jupiter.api.BeforeEach
 import org.junit.jupiter.api.Test
 import org.slf4j.Logger
@@ -356,6 +358,34 @@ class OpenApiGradlePluginTest {
 		}
 	}
 
+	@Test
+	fun `adding headers for custom generated url`() {
+		val outputJsonFileName: String = DEFAULT_OPEN_API_FILE_NAME
+		val buildDir: File = projectBuildDir
+		val customHost = "custom-host"
+		val customPort = "7000"
+
+		buildFile.writeText(
+			"""$baseBuildGradle
+		    bootRun {
+                args = ["--server.forward-headers-strategy=framework"]
+            }
+            openApi{
+                outputFileName = "$outputJsonFileName"
+				requestHeaders = [
+				   "x-forwarded-host": "$customHost",
+				   "x-forwarded-port": "$customPort"
+				]
+            }
+        """.trimMargin())
+
+		assertEquals(TaskOutcome.SUCCESS, openApiDocsTask(runTheBuild()).outcome)
+		assertOpenApiJsonFile(1, outputJsonFileName)
+		val openApiJson = getOpenApiJsonAtLocation(File(buildDir, outputJsonFileName))
+		val servers: JsonArray<Map<String, String>>? = openApiJson.array("servers")
+		assertTrue(servers!!.any { s -> s.get("url").equals("http://$customHost:$customPort") })
+	}
+
 	private fun runTheBuild(vararg additionalArguments: String = emptyArray()) =
 		GradleRunner.create()
 			.withProjectDir(projectTestDir)