de.codecentric.hikaku.endpoints.Endpoint.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.endpoints

import de.codecentric.hikaku.endpoints.HttpMethod.OPTIONS

/**
 * A single [Endpoint] containing all information. Each [Endpoint] consists of exactly one path in combination with exactly one [HttpMethod].
 * If a REST endpoint supports multiple [HttpMethod]s, this will result in multiple [Endpoint] instances.
 * @param path The path excluding a base path. **Example:** `/todos`
 * @param produces Supported media types for the response.
 * @param consumes Supported media types for the request.
 */
data class Endpoint(
        val path: String = "",
        val httpMethod: HttpMethod = OPTIONS,
        val queryParameters: Set = emptySet(),
        val pathParameters: Set = emptySet(),
        val headerParameters: Set = emptySet(),
        val produces: Set = emptySet(),
        val consumes: Set = emptySet()
)