Endpoint

interface Endpoint

Represents an endpoint, i.e., a remote HTTP resource.

Properties

Handles errors in responses.

abstract val httpClient: OkHttpClient

The HTTP client used to communicate with the remote resource.

Extracts links from responses.

A list of serializers used for entities received from the server, sorted from most to least preferred. Always uses first for sending to the server.

abstract val uri: URI

The HTTP URI of the remote resource.

Resolves all links with a specific relation type. Uses cached data from last response.

abstract fun link(rel: String): URI

Resolves a single link with a specific relation type. Uses cached data from last response if possible.

abstract fun linkTemplate(rel: String, variables: Map<String, Any>): URI

Resolves a link template with a specific relation type. Uses cached data from last response if possible.