added @OpenAPIName to remap parameter names

Author: Wicpar

src/main/kotlin/com/papsign/ktor/openapigen/KTypeUtil.kt

@@ -1,5 +1,6 @@
 package com.papsign.ktor.openapigen
 
+import com.papsign.ktor.openapigen.annotations.mapping.openAPIName
 import java.lang.reflect.Field
 import kotlin.reflect.*
 import kotlin.reflect.full.createType

src/main/kotlin/com/papsign/ktor/openapigen/annotations/mapping/OpenAPIName.kt

@@ -0,0 +1,19 @@
+package com.papsign.ktor.openapigen.annotations.mapping
+
+import java.util.*
+import kotlin.reflect.KParameter
+import kotlin.reflect.full.findAnnotation
+
+@Target(AnnotationTarget.VALUE_PARAMETER)
+annotation class OpenAPIName(val name: String)
+
+private val cache = Collections.synchronizedMap(HashMap<KParameter, String?>())
+
+val KParameter.openAPIName: String?
+    get() = cache.getOrPut(this) { findAnnotation<OpenAPIName>()?.name ?: name }
+
+fun <T> KParameter.remapOpenAPINames(map: Map<String, T>): Map<String, T> {
+    val replace = this.openAPIName
+    val actual = this.name
+    return if (actual != null && replace != actual) map.mapKeys { (key, _) -> if (key == replace) actual else key } else map
+}

src/main/kotlin/com/papsign/ktor/openapigen/content/type/multipart/MultipartFormDataContentProvider.kt

@@ -1,6 +1,7 @@
 package com.papsign.ktor.openapigen.content.type.multipart
 
 import com.papsign.ktor.openapigen.*
+import com.papsign.ktor.openapigen.annotations.mapping.openAPIName
 import com.papsign.ktor.openapigen.content.type.BodyParser
 import com.papsign.ktor.openapigen.content.type.ContentTypeProvider
 import com.papsign.ktor.openapigen.exceptions.assertContent
@@ -87,7 +88,7 @@ object MultipartFormDataContentProvider : BodyParser, OpenAPIGenModuleExtension
         }
         val ctor = clazz.primaryConstructor!!
         return ctor.callBy(ctor.parameters.associateWith {
-            val raw = objectMap[it.name]
+            val raw = objectMap[it.openAPIName]
             if ((raw == null || (raw !is InputStream && streamTypes.contains(it.type))) && it.type.isMarkedNullable) {
                 null
             } else {
@@ -97,7 +98,7 @@ object MultipartFormDataContentProvider : BodyParser, OpenAPIGenModuleExtension
                     val cvt = conversionsByType[it.type] ?: error("Unhandled Type ${it.type}")
                     when (raw) {
                         null -> {
-                            cvt.default ?: error("No provided value for field ${it.name}")
+                            cvt.default ?: error("No provided value for field ${it.openAPIName}")
                         }
                         is String -> {
                             cvt.parser(raw)

src/main/kotlin/com/papsign/ktor/openapigen/model/DataModel.kt

@@ -1,5 +1,6 @@
 package com.papsign.ktor.openapigen.model
 
+import com.papsign.ktor.openapigen.annotations.mapping.openAPIName
 import kotlin.reflect.KProperty1
 import kotlin.reflect.full.memberProperties
 

src/main/kotlin/com/papsign/ktor/openapigen/model/security/FlowsModel.kt

@@ -1,5 +1,6 @@
 package com.papsign.ktor.openapigen.model.security
 
+import com.papsign.ktor.openapigen.annotations.mapping.openAPIName
 import com.papsign.ktor.openapigen.model.DataModel
 import com.papsign.ktor.openapigen.model.Described
 import java.util.*

…eters/handlers/ModularParameterHander.kt …ters/handlers/ModularParameterHandler.ktsrc/main/kotlin/com/papsign/ktor/openapigen/parameters/handlers/ModularParameterHander.kt renamed to src/main/kotlin/com/papsign/ktor/openapigen/parameters/handlers/ModularParameterHandler.kt src/main/kotlin/com/papsign/ktor/openapigen/parameters/handlers/ModularParameterHander.kt renamed to src/main/kotlin/com/papsign/ktor/openapigen/parameters/handlers/ModularParameterHandler.kt

@@ -1,6 +1,8 @@
 package com.papsign.ktor.openapigen.parameters.handlers
 
 import com.papsign.ktor.openapigen.OpenAPIGen
+import com.papsign.ktor.openapigen.annotations.mapping.remapOpenAPINames
+import com.papsign.ktor.openapigen.annotations.mapping.openAPIName
 import com.papsign.ktor.openapigen.annotations.parameters.HeaderParam
 import com.papsign.ktor.openapigen.annotations.parameters.PathParam
 import com.papsign.ktor.openapigen.annotations.parameters.QueryParam
@@ -20,19 +22,19 @@ import kotlin.reflect.KParameter
 import kotlin.reflect.full.findAnnotation
 import kotlin.reflect.full.withNullability
 
-class ModularParameterHander<T>(val parsers: Map<KParameter, Builder<*>>, val constructor: KFunction<T>) :
+class ModularParameterHandler<T>(val parsers: Map<KParameter, Builder<*>>, val constructor: KFunction<T>) :
     ParameterHandler<T> {
 
     override fun parse(parameters: Parameters, headers: Headers): T {
-        return constructor.callBy(parsers.mapValues { it.value.build(it.key.name!!, parameters.toMap() + headers.toMap()) })
+        return constructor.callBy(parsers.mapValues { it.value.build(it.key.name.toString(), it.key.remapOpenAPINames(parameters.toMap() + headers.toMap())) })
     }
 
     override fun getParameters(apiGen: OpenAPIGen, provider: ModuleProvider<*>): List<ParameterModel<*>> {
         val schemaBuilder = provider.ofClass<FinalSchemaBuilderProviderModule>().last().provide(apiGen, provider)
 
         fun createParam(param: KParameter, `in`: ParameterLocation, config: (ParameterModel<*>) -> Unit): ParameterModel<*> {
             return ParameterModel<Any>(
-                param.name.toString(),
+                param.openAPIName.toString(),
                 `in`,
                 !param.type.isMarkedNullable
             ).also {

src/main/kotlin/com/papsign/ktor/openapigen/parameters/parsers/builders/query/deepobject/ObjectDeepBuilder.kt

@@ -1,5 +1,6 @@
 package com.papsign.ktor.openapigen.parameters.parsers.builders.query.deepobject
 
+import com.papsign.ktor.openapigen.annotations.mapping.openAPIName
 import com.papsign.ktor.openapigen.parameters.QueryParamStyle
 import com.papsign.ktor.openapigen.parameters.parsers.builders.Builder
 import com.papsign.ktor.openapigen.parameters.parsers.builders.BuilderSelector
@@ -32,7 +33,7 @@ class ObjectDeepBuilder(val type: KType) : DeepBuilder {
 
     override fun build(key: String, parameters: Map<String, List<String>>): Any? {
         return try {
-            constructor.callBy(builderMap.mapValues { it.value.build("$key[${it.key.name}]", parameters) })
+            constructor.callBy(builderMap.mapValues { it.value.build("$key[${it.key.openAPIName}]", parameters) })
         } catch (e: InvocationTargetException) {
             null
         }

src/main/kotlin/com/papsign/ktor/openapigen/parameters/parsers/converters/object/ObjectConverter.kt

@@ -1,5 +1,6 @@
 package com.papsign.ktor.openapigen.parameters.parsers.converters.`object`
 
+import com.papsign.ktor.openapigen.annotations.mapping.openAPIName
 import com.papsign.ktor.openapigen.parameters.parsers.converters.Converter
 import com.papsign.ktor.openapigen.parameters.parsers.converters.ConverterSelector
 import com.papsign.ktor.openapigen.parameters.parsers.converters.primitive.PrimitiveConverterFactory
@@ -30,7 +31,7 @@ class ObjectConverter(type: KType): MappedConverter {
     }
 
     override fun convert(map: Map<String, String>): Any? {
-        return try { constructor.callBy(builderMap.mapValues { (key, value) -> map[key.name]?.let { value.convert(it) }  }) } catch (e: InvocationTargetException) { null }
+        return try { constructor.callBy(builderMap.mapValues { (key, value) -> map[key.openAPIName]?.let { value.convert(it) }  }) } catch (e: InvocationTargetException) { null }
     }
 
     companion object: ConverterSelector {

src/main/kotlin/com/papsign/ktor/openapigen/parameters/util/Util.kt

@@ -3,7 +3,7 @@ package com.papsign.ktor.openapigen.parameters.util
 import com.papsign.ktor.openapigen.annotations.parameters.HeaderParam
 import com.papsign.ktor.openapigen.annotations.parameters.PathParam
 import com.papsign.ktor.openapigen.annotations.parameters.QueryParam
-import com.papsign.ktor.openapigen.parameters.handlers.ModularParameterHander
+import com.papsign.ktor.openapigen.parameters.handlers.ModularParameterHandler
 import com.papsign.ktor.openapigen.parameters.handlers.ParameterHandler
 import com.papsign.ktor.openapigen.parameters.handlers.UnitParameterHandler
 import com.papsign.ktor.openapigen.parameters.parsers.builders.Builder
@@ -24,7 +24,7 @@ inline fun <reified T : Any> buildParameterHandler(): ParameterHandler<T> {
         param.findAnnotation<QueryParam>()?.let { a -> a.style.factory.buildBuilderForced(type, a.explode) } ?:
         error("Parameters must be annotated with @PathParam or @QueryParam")
     }
-    return ModularParameterHander(
+    return ModularParameterHandler(
         parsers,
         constructor
     )

src/test/kotlin/TestServer.kt

@@ -12,6 +12,7 @@ import com.papsign.ktor.openapigen.OpenAPIGen
 import com.papsign.ktor.openapigen.annotations.Path
 import com.papsign.ktor.openapigen.annotations.Request
 import com.papsign.ktor.openapigen.annotations.Response
+import com.papsign.ktor.openapigen.annotations.mapping.OpenAPIName
 import com.papsign.ktor.openapigen.annotations.parameters.HeaderParam
 import com.papsign.ktor.openapigen.annotations.parameters.PathParam
 import com.papsign.ktor.openapigen.annotations.type.`object`.example.ExampleProvider
@@ -154,7 +155,7 @@ object TestServer {
                         info("Header Param Endpoint", "This is a Header Param Endpoint"),
                         example = NameGreetingResponse("Hi, openapi!")
                     ) { params ->
-                        respond(NameGreetingResponse("Hi, ${params.`X-Name`}!"))
+                        respond(NameGreetingResponse("Hi, ${params.name}!"))
                     }
                 }
 
@@ -223,7 +224,7 @@ object TestServer {
     @Response("A String Response")
     data class StringResponse(val str: String)
 
-    data class NameParam(@HeaderParam("A simple Header Param") val `X-Name`: String)
+    data class NameParam(@HeaderParam("A simple Header Param") @OpenAPIName("X-NAME") val name: String)
 
     @Response("A Response for header param example")
     data class NameGreetingResponse(val str: String)