annotations/io.github.kingg22.ktorgen.core/KtorGen

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)(source)

Annotation used to generate client implementations for Ktor client interfaces.

This annotation is typically used to mark interfaces intended to define API contracts, enabling automatic generation of client-side code based on the provided configuration.

The annotation provides customization options such as specifying a custom implementation class name, controlling generation behavior, defining base paths, adding custom file and class headers, and more.

By default, the generated implementation will have:

Named as the interface name plus the suffix Impl.
A class with the same visibility as the interface.
A constructor with a single HttpClient parameter + properties + delegated if are defined in the interface.