devview-networkmock-core/com.worldline.devview.networkmock.core.model

Package-level declarations

Types

@Serializable

data class ApiGroupConfig(val id: String, val name: String, val endpoints: List<EndpointConfig>, val environments: List<EnvironmentConfig>)

Configuration for a named, stable API group (e.g. "my-backend", "jsonplaceholder").

EndpointConfig

@Immutable

@Serializable

data class EndpointConfig(val id: String, val name: String, val path: String, val method: String) : EndpointDefinition

Configuration for a single API endpoint that can be mocked.

EndpointDefinition

sealed interface EndpointDefinition

Common contract for endpoint definitions in the mock configuration.

EndpointDescriptor

@Immutable

@Serializable

data class EndpointDescriptor(val key: EndpointKey, val config: EndpointConfig, val availableResponses: List<MockResponse>)

Represents the static descriptor for an available endpoint and its mock responses.

EndpointKey

@Immutable

@Serializable

data class EndpointKey(val groupId: String, val environmentId: String, val endpointId: String)

A stable, value-type identifier for the triple (groupId, environmentId, endpointId).

EndpointMockState

@Immutable

@Serializable

sealed interface EndpointMockState

Represents the mocking state for a single API endpoint.

EndpointOverride

@Serializable

data class EndpointOverride(val id: String, val name: String? = null, val path: String? = null, val method: String? = null) : EndpointDefinition

A partial override for a shared EndpointConfig within a specific EnvironmentConfig.

EnvironmentConfig

@Serializable

data class EnvironmentConfig(val id: String, val name: String, val url: String, val endpointOverrides: List<EndpointOverride> = emptyList(), val additionalEndpoints: List<EndpointConfig> = emptyList())

Configuration for a single deployment environment within an ApiGroupConfig.

MockConfiguration

@Serializable

data class MockConfiguration(val apiGroups: List<ApiGroupConfig>)

Root configuration for network mocking, loaded from mocks.json.

MockMatch

@Immutable

data class MockMatch(val key: EndpointKey, val config: EndpointConfig)

Represents a matched mock configuration for an incoming HTTP request.

MockResponse

@Immutable

@Serializable

data class MockResponse(val statusCode: Int, val fileName: String, val displayName: String, val content: String)

Represents a loaded mock response that can be returned by the network mock plugin.

NetworkMockState

@Serializable

data class NetworkMockState(val globalMockingEnabled: Boolean = false, val endpointStates: Map<String, EndpointMockState> = emptyMap(), val lastModified: Long = 0)

Represents the complete state of network mocking, persisted in DataStore.

StatusCodeFamily

enum StatusCodeFamily : Enum<StatusCodeFamily>

Functions

effectiveEndpoints

fun ApiGroupConfig.effectiveEndpoints(environment: EnvironmentConfig): List<EndpointConfig>

Builds the effective endpoint list for a given ApiGroupConfig and EnvironmentConfig pair.