mockzilla-common/com.apadmi.mockzilla.lib.models/EndpointConfiguration

EndpointConfiguration

data class EndpointConfiguration(val name: String, val key: EndpointConfiguration.Key, val shouldFail: Boolean, val delay: Int? = null, val dashboardOptionsConfig: DashboardOptionsConfig, val versionCode: Int, val endpointMatcher: suspend MockzillaHttpRequest.() -> Boolean, val defaultHandler: suspend MockzillaHttpRequest.() -> MockzillaHttpResponse, val errorHandler: suspend MockzillaHttpRequest.() -> MockzillaHttpResponse)

Configures a single mock endpoint within a Mockzilla server. Defines how incoming requests are matched to this endpoint and what response to return, along with optional dashboard presets and latency simulation.

Construct via Builder.

Constructors

constructor(name: String, key: EndpointConfiguration.Key, shouldFail: Boolean, delay: Int? = null, dashboardOptionsConfig: DashboardOptionsConfig, versionCode: Int, endpointMatcher: suspend MockzillaHttpRequest.() -> Boolean, defaultHandler: suspend MockzillaHttpRequest.() -> MockzillaHttpResponse, errorHandler: suspend MockzillaHttpRequest.() -> MockzillaHttpResponse)

Types

Builder

class Builder(key: String)

Key

@Serializable

@JvmInline

value class Key(val raw: String)

Unique serializable identifier for an EndpointConfiguration. Used to reference endpoints in management API operations such as cache clearing or runtime overrides.

Properties

dashboardOptionsConfig

val dashboardOptionsConfig: DashboardOptionsConfig

Preset responses available to users in the management dashboard.

defaultHandler

val defaultHandler: suspend MockzillaHttpRequest.() -> MockzillaHttpResponse

Called when a request matches this endpoint and shouldFail is false. Returns the mock response to send back to the caller.

delay

val delay: Int?

Artificial response delay in milliseconds. null falls back to the global delay set on MockzillaConfig.Builder.

endpointMatcher

val endpointMatcher: suspend MockzillaHttpRequest.() -> Boolean

Predicate that determines whether an incoming request should be routed to this endpoint. The first matching endpoint wins.

errorHandler

val errorHandler: suspend MockzillaHttpRequest.() -> MockzillaHttpResponse

Called when a request matches this endpoint and shouldFail is true. Returns the simulated error response to send back to the caller.

key

val key: EndpointConfiguration.Key

Unique identifier for this endpoint, used in management API operations.

name

val name: String

Human-readable display name shown in the management dashboard.

shouldFail

val shouldFail: Boolean

Whether this endpoint returns an error response by default. When true, errorHandler is called instead of defaultHandler.

versionCode

val versionCode: Int

Version number for this endpoint's configuration. Incrementing this value automatically invalidates any cached responses on connected devices.