EndpointMockState

Represents the mocking state for a single API endpoint.

Each endpoint is either passing traffic through to the actual network or returning a specific mock response. The two variants are represented as distinct types, eliminating any ambiguous state combinations that existed in the previous boolean-flag approach.

Variants

Usage Example

// Configure endpoint to use a mock response
val state = EndpointMockState.Mock(responseFile = "getUser-200.json")

// Configure endpoint to use the actual network
val state = EndpointMockState.Network

Checking the state

when (state) {
    is EndpointMockState.Network -> { /* use real network */}
    is EndpointMockState.Mock    -> { /* load mock from state.responseFile */}
}

Response File Naming Convention

The Mock.responseFile should match one of the available response files for the endpoint, following the naming convention:

• {endpointId}-{statusCode}.json

• {endpointId}-{statusCode}-{suffix}.json

Example files for a getUser endpoint:

• getUser-200.json

• getUser-404-simple.json

• getUser-404-detailed.json

• getUser-500.json

See also

Inheritors