compass-tools-web/dev.jordond.compass.tools.web/HttpApiEndpoint

HttpApiEndpoint

interface HttpApiEndpoint<Params, Result>

Defines an HTTP API endpoint.

Parameters

Params

The type of the parameters to be passed to the endpoint.

Result

The type of the result returned after mapping the response.

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
abstract suspend fun mapResponse(response: HttpResponse): Result

Maps the HttpResponse to the Result type.

Link copied to clipboard
abstract fun url(param: Params): String

Returns the URL for the endpoint with the given parameters.