de.codecentric.hikaku.HikakuConfig.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hikaku-core Show documentation

A library that tests if the implementation of a REST-API meets its specification. This module contains the core elements which can be used to create additional converters and reporters.

There is a newer version: 3.3.0

Show newest version

package de.codecentric.hikaku

import de.codecentric.hikaku.endpoints.Endpoint
import de.codecentric.hikaku.endpoints.HttpMethod.HEAD
import de.codecentric.hikaku.endpoints.HttpMethod.OPTIONS
import de.codecentric.hikaku.reporters.CommandLineReporter
import de.codecentric.hikaku.reporters.MatchResult
import de.codecentric.hikaku.reporters.Reporter

/**
 * Configuration for [Hikaku] class. It lets you partially control the matching process.
 * @param ignorePaths If the path of an [Endpoint] is included in this [Set], all checks for that [Endpoint] will be skipped.
 * @param ignoreHttpMethodHead All checks for an [Endpoint] providing http method [HEAD] will be skipped if set to `true`.
 * @param ignoreHttpMethodOptions All checks for an [Endpoint] providing http method [OPTIONS] will be skipped if set to `true`.
 * @param reporter The [MatchResult] will be passed to one or many [Reporter] before the test either fails or succeeds. Default is a [CommandLineReporter] that prints the results to [System.out].
 */
data class HikakuConfig
@JvmOverloads constructor(
        val ignorePaths: Set = emptySet(),
        val ignoreHttpMethodHead: Boolean = false,
        val ignoreHttpMethodOptions: Boolean = false,
        val reporter: List = listOf(CommandLineReporter())
)