Mokksy/dev.mokksy.mokksy

Package-level declarations

Core server, stub registration, and configuration.

Types

Defines the building step for associating an inbound RequestSpecification with its corresponding response definition. This class is part of a fluent API used to define mappings between request specifications and their respective responses.

ExperimentalMokksyApi

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.LOCAL_VARIABLE, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.TYPEALIAS])

annotation class ExperimentalMokksyApi

This annotation marks the Mokksy API that is considered experimental and is not subject to the general compatibility guarantees. The behaviour of such API may change, or the API may be removed completely in any further release.

InternalMokksyApi

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.TYPEALIAS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER])

annotation class InternalMokksyApi

API marked with this annotation is internal, and it is not intended to be used outside Mokksy. It could be modified or removed without any notice. Using it outside Mokksy could cause undefined behaviour and/or any unexpected effects.

JavaBuildingStep

class JavaBuildingStep

A Java-friendly wrapper around BuildingStep that exposes respondsWith, respondsWithStream, and respondsWithSseStream as instance methods accepting Consumer instead of Kotlin suspend lambdas.

JavaRequestSpecificationBuilder

class JavaRequestSpecificationBuilder

Java-friendly wrapper around RequestSpecificationBuilder that replaces Kotlin functional types with their java.util.function equivalents.

JavaResponseDefinitionBuilder

class JavaResponseDefinitionBuilder

Java-friendly wrapper around ResponseDefinitionBuilder that returns this from every mutating method, enabling fluent chaining without Kotlin-specific idioms.

JavaStreamingResponseDefinitionBuilder

class JavaStreamingResponseDefinitionBuilder

Java-friendly wrapper around StreamingResponseDefinitionBuilder that returns this from every mutating method, enabling fluent chaining without Kotlin-specific idioms.

JournalMode

enum JournalMode : Enum<JournalMode>

Controls which requests are recorded in the dev.mokksy.mokksy.request.RequestJournal.

MokksyDsl

@DslMarker

annotation class MokksyDsl

DSL marker for the Mokksy stub-definition DSL.

MokksyHandler

interface MokksyHandler

Minimal contract for embedding Mokksy stub handling into a Ktor application.

MokksyServer

class MokksyServer @JvmOverloads constructor(host: String = DEFAULT_HOST, port: Int = 0, val configuration: ServerConfiguration, configurer: Application.() -> Unit = {}) : MokksyHandler

An embedded mock HTTP server for testing. Registers stubs for any HTTP method and verifies request expectations after the test.

ServerConfiguration

data class ServerConfiguration @JvmOverloads constructor(val verbose: Boolean = false, val name: String? = "Mokksy", val journalMode: JournalMode = JournalMode.LEAN, val json: Json = Json { ignoreUnknownKeys = true }, val contentNegotiationConfigurer: (ContentNegotiationConfig) -> Unit = { it.json(json) })

Configuration for a MokksyServer instance.

SseEvent

object SseEvent

Java-friendly factory for creating ServerSentEvent instances without trailing nulls.

SseEventBuilder

class SseEventBuilder

Fluent builder for ServerSentEvent.

StubConfiguration

@JvmRecord

data class StubConfiguration @JvmOverloads constructor(val name: String? = null, val eventuallyRemove: Boolean = false, val verbose: Boolean = false)

Configuration for a stub's lifecycle and logging behaviour.

Functions

delete

inline fun MokksyServer.delete(configuration: StubConfiguration, noinline block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Reified shortcut for MokksyServer.delete with a StubConfiguration. Infers P from the call site.

inline fun MokksyServer.delete(name: String? = null, noinline block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Reified shortcut for MokksyServer.delete with an optional stub name. Infers P from the call site.

get

inline fun MokksyServer.get(configuration: StubConfiguration, noinline block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Reified shortcut for MokksyServer.get with a StubConfiguration. Infers P from the call site.

inline fun MokksyServer.get(name: String? = null, noinline block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Reified shortcut for MokksyServer.get with an optional stub name. Infers P from the call site.

head

inline fun MokksyServer.head(configuration: StubConfiguration, noinline block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Reified shortcut for MokksyServer.head with a StubConfiguration. Infers P from the call site.

inline fun MokksyServer.head(name: String? = null, noinline block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Reified shortcut for MokksyServer.head with an optional stub name. Infers P from the call site.

method

inline fun MokksyServer.method(configuration: StubConfiguration, httpMethod: HttpMethod, noinline block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Reified shortcut for MokksyServer.method with a StubConfiguration. Infers P from the call site.

inline fun MokksyServer.method(name: String? = null, httpMethod: HttpMethod, noinline block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Reified shortcut for MokksyServer.method with an optional stub name. Infers P from the call site.

Mokksy

expect fun Mokksy(host: String = DEFAULT_HOST, port: Int = 0, verbose: Boolean = false, configurer: Application.() -> Unit = {}): MokksyServer

Creates a MokksyServer — idiomatic Kotlin entry point for all platforms.

@JvmOverloads

actual fun Mokksy(host: String, port: Int, verbose: Boolean, configurer: Application.() -> Unit): MokksyServer

Creates a MokksyServer — idiomatic Kotlin entry point for all platforms.

actual fun Mokksy(host: String, port: Int, verbose: Boolean, configurer: Application.() -> Unit): MokksyServer

Creates a MokksyServer — idiomatic Kotlin entry point for all platforms.

actual fun Mokksy(host: String, port: Int, verbose: Boolean, configurer: Application.() -> Unit): MokksyServer

Creates a MokksyServer — idiomatic Kotlin entry point for all platforms.

mokksy

fun Application.mokksy(server: MokksyHandler, path: String = "{...}")

Installs Mokksy request handling into this Application.

fun Route.mokksy(server: MokksyHandler, path: String = "{...}")

Mounts Mokksy request handling into this Route scope.

options

inline fun MokksyServer.options(configuration: StubConfiguration, noinline block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Reified shortcut for MokksyServer.options with a StubConfiguration. Infers P from the call site.

inline fun MokksyServer.options(name: String? = null, noinline block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Reified shortcut for MokksyServer.options with an optional stub name. Infers P from the call site.

patch

inline fun MokksyServer.patch(configuration: StubConfiguration, noinline block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Reified shortcut for MokksyServer.patch with a StubConfiguration. Infers P from the call site.

inline fun MokksyServer.patch(name: String? = null, noinline block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Reified shortcut for MokksyServer.patch with an optional stub name. Infers P from the call site.

post

inline fun MokksyServer.post(configuration: StubConfiguration, noinline block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Reified shortcut for MokksyServer.post with a StubConfiguration. Infers P from the call site.

inline fun MokksyServer.post(name: String? = null, noinline block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Reified shortcut for MokksyServer.post with an optional stub name. Infers P from the call site.

put

inline fun MokksyServer.put(configuration: StubConfiguration, noinline block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Reified shortcut for MokksyServer.put with a StubConfiguration. Infers P from the call site.

inline fun MokksyServer.put(name: String? = null, noinline block: RequestSpecificationBuilder.() -> Unit): BuildingStep

Reified shortcut for MokksyServer.put with an optional stub name. Infers P from the call site.

respondsWith

fun BuildingStep.respondsWith(responseType: Class<T>, configurer: Consumer<ResponseDefinitionBuilder<P, T>>)

Java-friendly overload for BuildingStep.respondsWith.

respondsWithStream

fun BuildingStep.respondsWithStream(responseType: Class<T>, configurer: Consumer<StreamingResponseDefinitionBuilder<P, T>>)

Java-friendly overload for BuildingStep.respondsWithStream.

shutdown

@JvmOverloads

fun MokksyServer.shutdown(gracePeriodMillis: Long = 500, timeoutMillis: Long = 1000)

Stops the Mokksy server, blocking until shutdown is complete.

fun MokksyServer.shutdown(gracePeriodMillis: Long = 500, timeoutMillis: Long = 1000, dispatcher: CoroutineDispatcher)

Stops the Mokksy server on the given dispatcher, blocking until shutdown is complete.

start

fun MokksyServer.start(): MokksyServer

Starts the Mokksy server and blocks until the port is bound and ready to accept requests.

fun MokksyServer.start(dispatcher: CoroutineDispatcher): MokksyServer

Starts the Mokksy server on the given dispatcher, blocking until the port is bound.