annotations/io.github.kingg22.ktorgen.core

Package-level declarations

Core Annotations

This section documents the core annotations used to define options and how the compiler interprets them. These annotations control how Ktorgen scans interfaces, generates client factories, and connects them to Ktor’s HTTP client.

More information, see Core Annotations.

Types

Generated

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.FILE])

annotation class Generated

Each generated class, function, and files is annotated with this to identify them if they need to be excluded, for instance, by static analysis tools.

KtorGen

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class KtorGen(val name: String = KTORGEN_DEFAULT_NAME, val generate: Boolean = true, @Language(value = "http-url-reference") val basePath: String = "", val customFileHeader: String = KTORGEN_DEFAULT_NAME, val customClassHeader: String = "", val customFileName: String = KTORGEN_DEFAULT_NAME)

Annotation used to generate client implementations for Ktor client interfaces.

KtorGenAnnotationPropagation

@KtorGenExperimental

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])

annotation class KtorGenAnnotationPropagation(val propagateAnnotations: Boolean = true, val annotations: Array<KClass<out Annotation>> = [], val optInAnnotations: Array<KClass<out Annotation>> = [], val factoryFunctionAnnotations: Array<KClass<out Annotation>> = [])

This annotation provides fine-grained control over how annotations from the original interface method are handled and propagated to the generated implementation.

KtorGenCompanionExtFactory

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class KtorGenCompanionExtFactory(val name: String = "create")

Whether to generate a create(client) extension function of interface's companion object.

KtorGenExperimental

@Target(allowedTargets = [AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.PROPERTY])

annotation class KtorGenExperimental

Experimental API, the processor can omit the annotation, or generated code has errors.

KtorGenFunction

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class KtorGenFunction(val generate: Boolean = true, val customHeader: String = "")

Indicates that a method within a @KtorGen-annotated interface should participate in code generation.

KtorGenFunctionKmp

@KtorGenExperimental

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class ~~KtorGenFunctionKmp~~

An annotation used to mark an expect factory function for multi-platform support in KSP running on each platform.

KtorGenHttpClientExtFactory

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class KtorGenHttpClientExtFactory(val name: String = KTORGEN_DEFAULT_NAME)

Whether to generate an extension function on HttpClient to instantiate the API.

KtorGenKmpFactory

@KtorGenExperimental

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

expect annotation class KtorGenKmpFactory

An annotation used to mark an expect factory function for multi-platform support in KSP running on each platform.

KtorGenTopLevelFactory

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class KtorGenTopLevelFactory(val name: String = KTORGEN_DEFAULT_NAME)

Whether to generate a top-level function in the same package as the interface.

KtorGenVisibility

enum KtorGenVisibility : Enum<KtorGenVisibility>

Visibility modifier for generated code. Use with @KtorGenVisibilityControl()

KtorGenVisibilityControl

@KtorGenExperimental

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class KtorGenVisibilityControl(val visibilityModifier: KtorGenVisibility = KtorGenVisibility.DEFAULT, val classVisibilityModifier: KtorGenVisibility = KtorGenVisibility.DEFAULT, val constructorVisibilityModifier: KtorGenVisibility = KtorGenVisibility.DEFAULT, val factoryFunctionVisibilityModifier: KtorGenVisibility = KtorGenVisibility.DEFAULT)

KtorGenExperimental Indicate the visibility modifier for all generated code (class, primary constructor, and extension functions)