mokksy/me.kpavlov.mokksy/MokksyServer/head

head

fun <P : Any> head(name: String? = null, requestType: KClass<P>, block: RequestSpecificationBuilder<P>.() -> Unit): BuildingStep<P>

Configures an HTTP HEAD request specification using the provided block and returns a BuildingStep instance for further customization. This method uses the HTTP HEAD method to define the request specification within the provided lambda.

Return

A BuildingStep instance initialized with the generated request specification.

Parameters

P

type of the request payload

requestType

The class type of the request body.

block

A lambda used to configure the RequestSpecificationBuilder for the HEAD request.

fun <P : Any> head(configuration: StubConfiguration, requestType: KClass<P>, block: RequestSpecificationBuilder<P>.() -> Unit): BuildingStep<P>

Constructs a HEAD HTTP request with the provided configuration, request type, and specification block.

Return

A BuildingStep instance representing the constructed request.

Parameters

configuration

The configuration for the stubbed request.

requestType

The class type of the request payload.

block

A lambda that specifies the request parameters.

fun head(block: RequestSpecificationBuilder<String>.() -> Unit): BuildingStep<String>

Configures an HTTP HEAD request specification using the provided block and returns a BuildingStep for further customization. This method serves as a convenience shortcut.

Return

A BuildingStep instance initialized with the generated request specification.

Parameters

block

A lambda used to configure the RequestSpecificationBuilder for the GET request.