de.codecentric.hikaku.converters.EndpointConverter.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.converters

import de.codecentric.hikaku.SupportedFeatures
import de.codecentric.hikaku.SupportedFeatures.Feature
import de.codecentric.hikaku.endpoints.Endpoint

/**
 * Converts either a specific type of specification or implementation into the internal hikaku format in order to be able to perform a matching on the extracted components.
 */
interface EndpointConverter {

    /** Result of the conversion containing all extracted [Endpoint]s. */
    val conversionResult: Set

    /** List of [Feature]s that this [EndpointConverter]s supports. */
    val supportedFeatures: SupportedFeatures
}