annotations/io.github.kingg22.ktorgen.http

Package-level declarations

HTTP Annotations

These annotations define how Ktorgen maps Kotlin interfaces and methods into HTTP requests for Ktor Client.

Ktorgen’s HTTP annotations are inspired by Retrofit and Ktorfit, providing a familiar developer experience while maintaining KMP compatibility and type-safety.

More information, see HTTP Annotations.

Types

Body

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class Body

For upload data in an HTTP Body on a POST/PUT request

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

annotation class Cookie(val name: String, val value: String = KTORGEN_DEFAULT_NAME, val maxAge: Int = 0, val expiresTimestamp: Long = -1, val domain: String = "", val path: String = "", val secure: Boolean = false, val httpOnly: Boolean = false, val extensions: Array<Cookie.PairString> = [])

Add a cookie to the request.

DELETE

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class DELETE(@Language(value = "http-url-reference") val value: String = "")

Make a DELETE request.

Field

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class Field(val value: String = KTORGEN_DEFAULT_NAME, val encoded: Boolean = false)

A named pair for a form-encoded request.

FieldMap

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class FieldMap(val encoded: Boolean = false)

Named key/value pairs for a form-encoded request.

FormUrlEncoded

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class FormUrlEncoded

Indicate the body will use form URL encoding.

Fragment

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

annotation class Fragment(val value: String = KTORGEN_DEFAULT_NAME, val encoded: Boolean = false)

Add a hash mark # introduces the optional fragment near the end of the URL.

GET

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class GET(@Language(value = "http-url-reference") val value: String = "")

Make a GET request.

HEAD

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class HEAD(@Language(value = "http-url-reference") val value: String = "")

Make a HEAD request

Header

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class Header(@Language(value = "http-header-reference") val name: String, val value: String)

Add a header to a request

HeaderMap

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class HeaderMap

Add headers to a request

HeaderParam

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class HeaderParam(@Language(value = "http-header-reference") val value: String)

Adds a single HTTP header whose value is provided at call time.

Headers

annotation class ~~Headers~~(val values: String)

This is only for easy migration from other libraries, using this doesn't generate code

HTTP

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class HTTP(@Language(value = "http-method-reference") val method: String, @Language(value = "http-url-reference") val path: String = "", val hasBody: Boolean = false)

Make a request with a custom HTTP verb.

Multipart