ktorfit-ksp/de.jensklingenberg.ktorfit.model

Package-level declarations

Types

data class ClassData(val name: String, val packageName: String, val functions: List<FunctionData>, val imports: List<String>, val superClasses: List<KSTypeReference> = emptyList(), val properties: List<KSPropertyDeclaration> = emptyList(), val modifiers: List<KModifier> = emptyList(), val ksFile: KSFile)

FunctionData

data class FunctionData(val name: String, val returnType: ReturnTypeData, val isSuspend: Boolean = false, val parameterDataList: List<ParameterData>, val annotations: List<FunctionAnnotation> = emptyList(), val httpMethodAnnotation: HttpMethodAnnotation)

KtorfitClass

data class KtorfitClass(val name: String, val packageName: String, val objectName: String)

KtorfitError

class KtorfitError

ParameterData

data class ParameterData(val name: String, val type: ReturnTypeData, val annotations: List<ParameterAnnotation> = emptyList())

ReturnTypeData

data class ReturnTypeData(val name: String, val qualifiedName: String, val parameterType: KSTypeReference?)

Properties

clientClass

val clientClass: KtorfitClass

ktorfitClass

val ktorfitClass: KtorfitClass

ktorfitClientClass

val ktorfitClientClass: KtorfitClass

ktorfitServiceClassName

val ktorfitServiceClassName: ClassName

requestDataClass

val requestDataClass: KtorfitClass

WILDCARDIMPORT

const val WILDCARDIMPORT: String

Functions

addKtorfitSuperInterface

fun TypeSpec.Builder.addKtorfitSuperInterface(superClasses: List<KSTypeReference>): TypeSpec.Builder

Support for extending multiple interfaces, is done with Kotlin delegation. Ktorfit interfaces can only extend other Ktorfit interfaces, so there will be a generated implementation for each interface that we can use.

createParameterData

fun KSValueParameter.createParameterData(logger: KSPLogger): ParameterData

getImplClassFileSource

fun ClassData.getImplClassFileSource(resolver: Resolver): String

Transform a ClassData to a FileSpec for KotlinPoet

toClassData

fun KSClassDeclaration.toClassData(logger: KSPLogger): ClassData

Convert a KSClassDeclaration to ClassData

toFunctionData

fun KSFunctionDeclaration.toFunctionData(logger: KSPLogger): FunctionData