Mokksy/dev.mokksy.mokksy.response/AbstractResponseDefinitionBuilder

AbstractResponseDefinitionBuilder

abstract class AbstractResponseDefinitionBuilder<P, T>(var delay: Duration = Duration.ZERO)(source)

Represents a base abstraction for defining the attributes of an HTTP response in the context of request-to-response mappings. This class allows customization of the HTTP status code and headers and provides a mechanism for building concrete response definitions.

Author

Konstantin Pavlov

Type Parameters

P

The type of the request body, used to type the CapturedRequest available during building.

T

The type of the response data, which is returned to the client.

Inheritors

ResponseDefinitionBuilder

StreamingResponseDefinitionBuilder

Constructors

AbstractResponseDefinitionBuilder

constructor(delay: Duration = Duration.ZERO)

Types

HeadersConfigurer

inner class HeadersConfigurer

Provides the headers { } lambda and headers += pair-shorthand syntax for configuring response headers within a AbstractResponseDefinitionBuilder.

Properties

var delay: Duration

val headers: AbstractResponseDefinitionBuilder.HeadersConfigurer

Entry point for header configuration. Supports two syntaxes:

var httpStatus: HttpStatusCode

The HTTP status code of the response.

open var httpStatusCode: Int

The HTTP status code to be associated with the response.

Functions

fun addHeader(name: String, value: String)

Adds a single response header.