Fix wrong generation of default values for headers and queries (#194)

Author: jackcat13

restdocs-api-spec-gradle-plugin/src/test/kotlin/com/epages/restdocs/apispec/gradle/ApiSpecTaskTest.kt

@@ -122,6 +122,50 @@ abstract class ApiSpecTaskTest {
         )
     }
 
+    protected fun givenResourceSnippetWithDefaultHeader() {
+        val operationDir = File(snippetsFolder, "some-operation").apply { mkdir() }
+        File(operationDir, "resource.json").writeText(
+            """
+                {
+  "operationId" : "product-get",
+  "summary" : null,
+  "description" : null,
+  "privateResource" : false,
+  "deprecated" : false,
+  "request" : {
+    "path" : "/products/{id}",
+    "method" : "GET",
+    "contentType" : null,
+    "headers" : [ {
+      "name" : "one",
+      "attributes" : { },
+      "description" : "Override request header param",
+      "type" : "STRING",
+      "optional" : true,
+      "example" : "one",
+      "default" : "a default value"
+    } ],
+    "pathParameters" : [ ],
+    "requestParameters" : [ ],
+    "requestFields" : [ ],
+    "example" : null,
+    "securityRequirements" : {
+      "type": "OAUTH2",
+      "requiredScopes": ["prod:r"]
+    }
+  },
+  "response" : {
+    "status" : 200,
+    "contentType" : "application/hal+json",
+    "headers" : [ ],
+    "responseFields" : [ ],
+    "example" : "{\n  \"name\" : \"Fancy pants\",\n  \"price\" : 49.99,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"http://localhost:8080/products/7\"\n    },\n    \"product\" : {\n      \"href\" : \"http://localhost:8080/products/7\"\n    }\n  }\n}"
+  }
+}
+            """.trimIndent()
+        )
+    }
+
     protected fun givenPrivateResourceSnippet() {
         val operationDir = File(snippetsFolder, "some-private-operation").apply { mkdir() }
         File(operationDir, "resource.json").writeText(

restdocs-api-spec-gradle-plugin/src/test/kotlin/com/epages/restdocs/apispec/gradle/RestdocsOpenApi3TaskTest.kt

@@ -5,6 +5,7 @@ import org.assertj.core.api.BDDAssertions.then
 import org.junit.jupiter.api.Test
 import org.junit.jupiter.api.extension.ExtendWith
 import org.junitpioneer.jupiter.TempDirectory
+import java.lang.Boolean.FALSE
 
 @ExtendWith(TempDirectory::class)
 class RestdocsOpenApi3TaskTest : RestdocsOpenApiTaskTestBase() {
@@ -48,12 +49,35 @@ class RestdocsOpenApi3TaskTest : RestdocsOpenApiTaskTestBase() {
         thenSingleServerContainedInOutput()
     }
 
+    @Test
+    fun `should run openapi task with default values in headers`() {
+        givenBuildFileWithOpenApiClosureWithSingleServerString()
+        givenResourceSnippetWithDefaultHeader()
+
+        whenPluginExecuted()
+
+        thenApiSpecTaskSuccessful()
+        thenOutputFileFound()
+        thenHeaderWithDefaultValuesContainedInOutput()
+    }
+
     private fun thenSingleServerContainedInOutput() {
         with(outputFileContext()) {
             then(read<List<String>>("servers[*].url")).containsOnly("http://some.api")
         }
     }
 
+    private fun thenHeaderWithDefaultValuesContainedInOutput() {
+        with(outputFileContext()) {
+            then(read<String>("paths./products/{id}.get.parameters[1].name")).isEqualTo("one")
+            then(read<String>("paths./products/{id}.get.parameters[1].description")).isEqualTo("Override request header param")
+            then(read<Boolean>("paths./products/{id}.get.parameters[1].required")).isEqualTo(FALSE)
+            then(read<String>("paths./products/{id}.get.parameters[1].schema.type")).isEqualTo("string")
+            then(read<String>("paths./products/{id}.get.parameters[1].schema.default")).isEqualTo("a default value")
+            then(read<String>("paths./products/{id}.get.parameters[1].example")).isEqualTo("one")
+        }
+    }
+
     fun givenBuildFileWithOpenApiClosureWithSingleServerString() {
         givenBuildFileWithOpenApiClosure("server", """ 'http://some.api' """)
     }

restdocs-api-spec-model/build.gradle.kts

@@ -1,5 +1,7 @@
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
+val jacksonVersion: String by extra
+
 plugins {
     kotlin("jvm")
     signing
@@ -11,6 +13,7 @@ repositories {
 
 dependencies {
     compile(kotlin("stdlib-jdk8"))
+    implementation("com.fasterxml.jackson.core:jackson-annotations:$jacksonVersion")
 }
 
 publishing {

restdocs-api-spec-model/src/main/kotlin/com/epages/restdocs/apispec/model/ResourceModel.kt

@@ -1,5 +1,6 @@
 package com.epages.restdocs.apispec.model
 
+import com.fasterxml.jackson.annotation.JsonProperty
 import java.util.Comparator
 
 data class ResourceModel(
@@ -71,7 +72,7 @@ data class HeaderDescriptor(
     override val name: String,
     override val description: String,
     override val type: String,
-    override val defaultValue: Any? = null,
+    @JsonProperty("default") override val defaultValue: Any? = null,
     override val optional: Boolean,
     val example: String? = null,
     override val attributes: Attributes = Attributes()
@@ -101,7 +102,7 @@ data class ParameterDescriptor(
     override val name: String,
     override val description: String,
     override val type: String,
-    override val defaultValue: Any? = null,
+    @JsonProperty("default") override val defaultValue: Any? = null,
     override val optional: Boolean,
     val ignored: Boolean,
     override val attributes: Attributes = Attributes()