Fix multiple parameters in path parsing (#135)

* use regex to extract parameters from path in OpenApi 2.0 generator

* use regex to extract parameters from path in OpenApi 3.0 generator

* fixed typo in multi param test in OpenAPI 2.0 generator
added OpenAPI 3.0 multi param test

* fix typo

Author: Sushruth-Godugunuari

restdocs-api-spec-openapi-generator/src/main/kotlin/com/epages/restdocs/apispec/openapi2/OpenApi20Generator.kt

@@ -34,11 +34,13 @@ import io.swagger.models.properties.PropertyBuilder
 import io.swagger.util.Json
 import java.util.Comparator.comparing
 import java.util.Comparator.comparingInt
+import java.util.regex.Pattern
 
 object OpenApi20Generator {
 
     private const val API_KEY_SECURITY_NAME = "api_key"
     private const val BASIC_SECURITY_NAME = "basic"
+    private val PATH_PARAMETER_PATTERN = """\{([^/}]+)}""".toRegex()
     internal fun generate(
         resources: List<ResourceModel>,
         basePath: String? = null,
@@ -322,10 +324,9 @@ object OpenApi20Generator {
     }
 
     private fun extractPathParameters(resourceModel: ResourceModel): List<PathParameter> {
-        val pathParameterNames = resourceModel.request.path
-            .split("/")
-            .filter { it.startsWith("{") && it.endsWith("}") }
-            .map { it.removePrefix("{").removeSuffix("}") }
+        val pathParameterNames = PATH_PARAMETER_PATTERN.findAll(resourceModel.request.path)
+                .map { matchResult -> matchResult.groupValues[1]  }
+                .toList()
 
         return pathParameterNames.map { parameterName ->
             resourceModel.request.pathParameters

restdocs-api-spec-openapi-generator/src/test/kotlin/com/epages/restdocs/apispec/openapi2/OpenApi20GeneratorTest.kt

@@ -106,6 +106,15 @@ class OpenApi20GeneratorTest {
         thenPathParametersExist(openapi, api)
     }
 
+    @Test
+    fun `should extract multiple path parameters from path as fallback`() {
+        val api = givenGetProductResourceModelWithMultiplePathParameters()
+
+        val openapi = whenOpenApiObjectGenerated(api)
+
+        thenMultiplePathParametersExist(openapi, api)
+    }
+
     @Test
     fun `should convert resource with head http method`() {
         val api = givenHeadResourceModel()
@@ -270,6 +279,13 @@ class OpenApi20GeneratorTest {
         then(pathParameter.name).isEqualTo("id")
     }
 
+    private fun thenMultiplePathParametersExist(openapi: Swagger, api: List<ResourceModel>) {
+        val path = openapi.paths.getValue(api[0].request.path).get
+        then(path.parameters).hasSize(2)
+        then(path.parameters[0].name).isEqualTo("id")
+        then(path.parameters[1].name).isEqualTo("subId")
+    }
+
     private fun thenApiSpecificationWithoutJsonSchemaButWithExamplesIsGenerated(
         openapi: Swagger,
         api: List<ResourceModel>
@@ -448,6 +464,18 @@ class OpenApi20GeneratorTest {
         )
     }
 
+    private fun givenGetProductResourceModelWithMultiplePathParameters(): List<ResourceModel> {
+        return listOf(
+                ResourceModel(
+                        operationId = "test",
+                        privateResource = false,
+                        deprecated = false,
+                        request = getProductRequestWithMultiplePathParameters(),
+                        response = getProduct200Response(getProductPayloadExample())
+                )
+        )
+    }
+
     private fun givenPostProductResourceModelWithoutFieldDescriptors(): List<ResourceModel> {
         return listOf(
             ResourceModel(
@@ -788,6 +816,22 @@ class OpenApi20GeneratorTest {
         )
     }
 
+    private fun getProductRequestWithMultiplePathParameters(): RequestModel {
+        return RequestModel(
+                path = "/products/{id}-{subId}",
+                method = HTTPMethod.GET,
+                contentType = "application/json",
+                securityRequirements = SecurityRequirements(
+                        type = OAUTH2,
+                        requiredScopes = listOf("prod:r")
+                ),
+                headers = listOf(),
+                pathParameters = listOf(),
+                requestParameters = listOf(),
+                requestFields = listOf()
+        )
+    }
+
     private fun postProductRequest(schema: Schema? = null, path: String = "/products"): RequestModel {
         return RequestModel(
             path = path,

restdocs-api-spec-openapi3-generator/src/main/kotlin/com/epages/restdocs/apispec/openapi3/OpenApi3Generator.kt

@@ -41,6 +41,7 @@ import io.swagger.v3.oas.models.tags.Tag
 
 object OpenApi3Generator {
 
+    private val PATH_PARAMETER_PATTERN = """\{([^/}]+)}""".toRegex()
     internal fun generate(
         resources: List<ResourceModel>,
         servers: List<Server>,
@@ -344,10 +345,9 @@ object OpenApi3Generator {
     }
 
     private fun extractPathParameters(resourceModel: ResourceModel): List<PathParameter> {
-        val pathParameterNames = resourceModel.request.path
-            .split("/")
-            .filter { it.startsWith("{") && it.endsWith("}") }
-            .map { it.removePrefix("{").removeSuffix("}") }
+        val pathParameterNames = PATH_PARAMETER_PATTERN.findAll(resourceModel.request.path)
+                .map { matchResult -> matchResult.groupValues[1]  }
+                .toList()
 
         return pathParameterNames.map { parameterName ->
             resourceModel.request.pathParameters

restdocs-api-spec-openapi3-generator/src/test/kotlin/com/epages/restdocs/apispec/openapi3/OpenApi3GeneratorTest.kt

@@ -177,6 +177,16 @@ class OpenApi3GeneratorTest {
         thenOpenApiSpecIsValid()
     }
 
+    @Test
+    fun `should extract multiple parameters when seperated by delimiter`(){
+        givenResourceWithMultiplePathParameters()
+
+        whenOpenApiObjectGenerated()
+
+        thenMultiplePathParametersExist()
+
+    }
+
     fun thenGetProductByIdOperationIsValid() {
         val productGetByIdPath = "paths./products/{id}.get"
         then(openApiJsonPathContext.read<List<String>>("$productGetByIdPath.tags")).isNotNull()
@@ -206,6 +216,12 @@ class OpenApi3GeneratorTest {
         then(openApiJsonPathContext.read<List<List<String>>>("$productGetByIdPath.security[*].oauth2_authorizationCode").flatMap { it }).containsOnly("prod:r")
     }
 
+    private fun thenMultiplePathParametersExist() {
+        val productMultiparamPath = "paths./products/{id}-{subId}.get"
+        then(openApiJsonPathContext.read<List<String>>("$productMultiparamPath.parameters[?(@.name == 'id')].in")).containsOnly("path")
+        then(openApiJsonPathContext.read<List<String>>("$productMultiparamPath.parameters[?(@.name == 'subId')].in")).containsOnly("path")
+    }
+
     private fun thenServersPresent() {
         then(openApiJsonPathContext.read<List<String>>("servers[*].url")).contains("https://localhost/api")
     }
@@ -441,6 +457,21 @@ class OpenApi3GeneratorTest {
         )
     }
 
+    private fun givenResourceWithMultiplePathParameters() {
+        resources = listOf(
+                ResourceModel(
+                        operationId = "test",
+                        summary = "summary",
+                        description = "description",
+                        privateResource = false,
+                        deprecated = false,
+                        tags = setOf("tag1", "tag2"),
+                        request = getProductRequestWithMultiplePathParameters(),
+                        response = getProductResponse()
+                )
+        )
+    }
+
     private fun givenDeleteProductResourceModel() {
         resources = listOf(
             ResourceModel(
@@ -688,6 +719,34 @@ class OpenApi3GeneratorTest {
         )
     }
 
+    private fun getProductRequestWithMultiplePathParameters (getSecurityRequirement: () -> SecurityRequirements = ::getOAuth2SecurityRequirement): RequestModel {
+        return RequestModel(
+                path = "/products/{id}-{subId}",
+                method = HTTPMethod.GET,
+                securityRequirements = getSecurityRequirement(),
+                headers = listOf(
+                        HeaderDescriptor(
+                                name = "Authorization",
+                                description = "Access token",
+                                type = "string",
+                                optional = false,
+                                example = "some example"
+                        )
+                ),
+                pathParameters = emptyList(),
+                requestParameters = listOf(
+                        ParameterDescriptor(
+                                name = "locale",
+                                description = "Localizes the product fields to the given locale code",
+                                type = "STRING",
+                                optional = true,
+                                ignored = false
+                        )
+                ),
+                requestFields = listOf()
+        )
+    }
+
     private fun getProductRequest(getSecurityRequirement: () -> SecurityRequirements = ::getOAuth2SecurityRequirement): RequestModel {
         return RequestModel(
                 path = "/products/{id}",