kompendium-locations/io.bkbn.kompendium.locations/LocationMethodParser

LocationMethodParser

object LocationMethodParser : IMethodParser

Types

LocationBaseInfo

data class LocationBaseInfo(op: PathOperation, feature: Kompendium, path: String)

Functions

calculateLocationPath

fun KClass<*>.calculateLocationPath(suffix: String = ""): String

calculateRoutePath

open fun Route.calculateRoutePath(): String

defaultValueInjector

open fun defaultValueInjector(param: KParameter): Any

getDefaultParameterValue

open fun getDefaultParameterValue(clazz: KClass<*>, prop: KProperty<*>): Any?

open fun Set<ParameterExample>.mapToSpec(parameterName: String): Map<String, Parameter.Example>?

parseExceptions

open fun parseExceptions(exceptionInfo: Set<ExceptionInfo<*>>, feature: Kompendium): Map<Int, Response>

parseMethodInfo

open fun parseMethodInfo(info: MethodInfo<*, *>, paramType: KType, requestType: KType, responseType: KType, feature: Kompendium): PathOperation

open fun parseResponse(responseType: KType, responseInfo: ResponseInfo<*>?, feature: Kompendium): Map<Int, Response>

processBaseInfo

inline fun <TParam : Any> processBaseInfo(paramType: KType, requestType: KType, responseType: KType, info: MethodInfo<*, *>, route: Route): LocationMethodParser.LocationBaseInfo

open fun Kompendium.resolveContent(type: KType, mediaTypes: List<String>, examples: Map<String, Any>): Map<String, MediaType>?

open fun KProperty<*>.toParameter(info: MethodInfo<*, *>, parentType: KType, parentClazz: KClass<*>, feature: Kompendium): Parameter

toParameterSpec

open override fun KType.toParameterSpec(info: MethodInfo<*, *>, feature: Kompendium): List<Parameter>

open fun KType.toRequestSpec(requestInfo: RequestInfo<*>?, feature: Kompendium): Request?

open fun KType.toResponseSpec(responseInfo: ResponseInfo<*>?, feature: Kompendium): Pair<Int, Response>?