network/io.github.maniramezan.kenwork.network/NetworkEndpoint

NetworkEndpoint

A type-safe description of one HTTP endpoint. Mirrors SwiftyNetwork's NetworkEndpoint.

Implement this (typically as an object or data class per route) and pass it to NetworkClient. Only baseUrl, path, and method are required; the rest default sensibly.

Properties

authorization

open val authorization: AuthorizationType

Per-request authorization; defaults to AuthorizationType.None (use the client provider).

baseUrl

abstract val baseUrl: String

The scheme + host (+ optional base path), e.g. https://api.example.com.

body

open val body: ByteArray?

A raw request body, or null. Ignored when a typed body is passed to the client.

headers

open val headers: Map<String, String>?

Extra request headers, or null for none.

method

abstract val method: HttpMethod

The HTTP method.

path

abstract val path: String

The path relative to baseUrl, e.g. videos/42. Leading/trailing slashes are normalized.

queryItems

open val queryItems: List<Pair<String, String>>?

Query parameters appended to the URL, or null for none.