android/dev.kindling.android.http

Package-level declarations

Types

Defines how authentication headers are injected into every outgoing request.

data class KCacheConfig(val maxAgeSeconds: Long = 300, val maxEntries: Int = 100, val strategy: KCacheStrategy = KCacheStrategy.NetworkFirst)

Configuration for the in-memory HTTP response cache.

KCacheStrategy

enum KCacheStrategy : Enum<KCacheStrategy>

Cache strategy controlling when cached responses are used.

KDefaultTokenRefresher

class KDefaultTokenRefresher(refreshUrl: String, getRefreshToken: suspend () -> String?, onTokenRefreshed: suspend (accessToken: String, refreshToken: String) -> Unit, onFailed: suspend () -> Unit, authProvider: KAuthProvider? = null) : KTokenRefresher

Default KTokenRefresher implementation provided by Kindling.

KHttpConfig

data class KHttpConfig(val baseUrl: String, val engine: HttpClientEngine? = null, val connectTimeoutMs: Long, val requestTimeoutMs: Long, val logLevel: LogLevel = LogLevel.NONE, val onClientError: (Int, String) -> Unit? = null, val onServerError: (Int, String) -> Unit? = null, val onSessionExpired: () -> Unit? = null, val authPaths: List<String> = listOf("/auth/login", "/auth/register"), val cookieStorage: CookiesStorage? = null, val authProvider: KAuthProvider? = null, val tokenRefresher: KTokenRefresher? = null, val interceptor: KRequestInterceptor? = null, val cacheConfig: KCacheConfig? = null)

Configuration for buildKHttpClient.

KHttpException

sealed class KHttpException(message: String) : Exception

Sealed hierarchy of HTTP-related exceptions thrown by buildKHttpClient.

KMockEngineApi

annotation class KMockEngineApi

KMockHandler

data class KMockHandler(val method: HttpMethod, val path: String, val status: HttpStatusCode = HttpStatusCode.OK, val resolver: suspend (params: Map<String, String>, body: String?) -> Any?)

Represents a registered mock route handler.

KMockRegistry

object KMockRegistry

Thread-safe singleton registry storing all KMockHandler entries.

KRequestInterceptor

data class KRequestInterceptor(val onResponse: suspend (HttpResponse) -> Unit? = null)

Hook for observing every response globally.

KTokenRefresher

interface KTokenRefresher

Contract for automatic token refresh on 401 responses.

Properties

mockJson

val mockJson: Json

Functions

fun HttpResponse.accept(vararg codes: HttpStatusCode): HttpResponse

Asserts the response status is one of codes.

appendBytes

fun FormBuilder.appendBytes(partName: String, bytes: ByteArray, contentType: String, fileName: String)

Appends raw ByteArray content to the multipart form.

appendFile

fun FormBuilder.appendFile(partName: String, file: File, contentType: String = "application/octet-stream", fileName: String = file.name)

Appends a File to the multipart form with the given partName and contentType.

buildKHttpClient

fun buildKHttpClient(config: KHttpConfig): HttpClient

Builds a pre-configured Ktor HttpClient following the Kindling convention.

buildKMockEngine

fun buildKMockEngine(delayMs: Long = 300, apiPrefix: String = "/api"): MockEngine

kMockHandler

inline fun <T> kMockHandler(method: HttpMethod, path: String, status: HttpStatusCode = HttpStatusCode.OK, noinline resolver: suspend (params: Map<String, String>, body: String?) -> T): KMockHandler

Reified helper to create a KMockHandler that captures the return type's serializer. This avoids reflective lookup and correctly handles generic types in the mock response.

setBodyJson

inline fun <T> HttpRequestBuilder.setBodyJson(body: T)

Serialises body as JSON and sets Content-Type: application/json.

setBodyMultipart

fun HttpRequestBuilder.setBodyMultipart(block: FormBuilder.() -> Unit)

Sets a multipart/form-data body on the request.