Mokksy/dev.mokksy.mokksy.utils.logger/HttpFormatter

HttpFormatter

open class HttpFormatter(theme: ColorTheme = ColorTheme.LIGHT_ON_DARK, useColor: Boolean = isColorSupported(), json: Json = DefaultJson)(source)

A utility class to format HTTP requests and responses into colorized strings for better readability.

This formatter applies syntax highlighting based on HTTP methods, headers, bodies, and status codes. It supports customizable color themes and enables or disables colorization depending on platform support.

Parameters

theme

The color theme to be applied for formatting.

useColor

Boolean flag indicating whether ANSI color codes should be used in the formatting output.

json

The Json instance used to encode typed response bodies for display. Should match the instance used by Ktor's ContentNegotiation so that custom kotlinx.serialization.modules.SerializersModule registrations are reflected in logs.

Constructors

HttpFormatter

constructor(theme: ColorTheme = ColorTheme.LIGHT_ON_DARK, useColor: Boolean = isColorSupported(), json: Json = DefaultJson)

Types

ColorScheme

@InternalMokksyApi

data class ColorScheme(val path: AnsiColor, val headerName: AnsiColor, val headerValue: AnsiColor, val body: AnsiColor)

Functions

formatBody

fun formatBody(body: Any?, contentType: ContentType = ContentType.Any): String

Formats the HTTP body for display, applying syntax highlighting if color output is enabled.

header

fun header(k: String, values: List<String>): String

Formats an HTTP header line with colorized header name and values.

requestLine

fun requestLine(method: HttpMethod, path: String): String

Formats an HTTP request line with the method and path, applying colorization based on the selected theme.

responseLine

fun responseLine(httpVersion: String, status: HttpStatusCode): String