RestEndpoint

abstract class RestEndpoint<I : Any, O : Any>

A RestEndpoint implementation defines the API contract for a single REST API endpoint. Implementations must be Kotlin data classes or data objects. See this Feature's README or tests for some examples.

I (input) represents the type of the request body. If none, use Unit. O (output) represents the type of the response body. If none, use Unit.

Constructors

RestEndpoint

constructor()

Types

PathParam

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class PathParam

Marks a constructor parameter as a path parameter (matches :paramName in the path).

QueryParam

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class QueryParam

Marks a constructor parameter as a query parameter.

Properties

body

open val body: I

Override in data class endpoints that accept a request body. Throws NotImplementedError by default, which is expected for endpoints without a body.