Mokksy/dev.mokksy.mokksy.request

Package-level declarations

Request matching and recording. Use RequestSpecificationBuilder inside get { } / post { } blocks to match by path, headers, query parameters, and body.

Types

CapturedRequest

class CapturedRequest(request: ApplicationRequest, type: KClass)

Represents an HTTP request that has been captured and provides utilities to access the request's body and its string representation.

RecordedRequest

data class RecordedRequest(val method: HttpMethod, val uri: String, val headers: Map<String, List<String>>)

Immutable snapshot of an HTTP request for recording purposes.

RequestSpecification

open class RequestSpecification(val method: Matcher<HttpMethod>? = null, val path: Matcher<String>? = null, val headers: List<Matcher<Headers>> = listOf(), val body: List<Matcher<P?>> = listOf(), val bodyString: List<Matcher<String?>> = listOf(), val priority: Int = DEFAULT_STUB_PRIORITY, requestType: KClass)

Represents a specification for matching incoming HTTP requests based on defined criteria, such as HTTP method, request path, and request body.

RequestSpecificationBuilder

open class RequestSpecificationBuilder(requestType: KClass)

Properties

DEFAULT_STUB_PRIORITY

const val DEFAULT_STUB_PRIORITY: Int

The default priority value assigned to a stub when no explicit priority is specified.

Functions

predicateMatcher

fun <T> predicateMatcher(description: String? = null, predicate: (T?) -> Boolean): Matcher<T?>

Creates a matcher that evaluates objects against a specified predicate.

shouldHaveHeader

infix fun Headers.shouldHaveHeader(header: Pair<String, String>)

Extension function for easier usage.

shouldNotHaveHeader

infix fun Headers.shouldNotHaveHeader(header: Pair<String, String>)

Extension function to assert that the headers should not contain a specific header.

successCallMatcher

fun <T> successCallMatcher(description: String? = null, call: (T?) -> Unit): Matcher<T?>

Creates a matcher that tests whether the specified function call can execute successfully without throwing an exception when invoked with a given input value.