core/dev.akif.tapik/HttpEndpoint

HttpEndpoint

data class HttpEndpoint<out P : Parameters, out I : Input<*, *>, out O : Outputs>(source)

Immutable endpoint contract produced by the DSL.

This is the value Tapik generators and interpreters consume once the staged builders have collected the method, URI template, request shape, and possible responses into one object.

Parameters

typed tuple of path and query parameters referenced by the endpoint.

request contract covering headers and body.

response variants paired with status matchers.

Properties

description

val description: String?

short summary surfaced in generated documentation.

details

val details: String?

optional longer notes such as usage rules or caveats.

val id: String

stable endpoint identifier, usually derived from the declaring property name.

input

val input: I

request headers and body expected by the endpoint.

method

val method: Method

HTTP method handled by the endpoint.

outputs

val outputs: O

response variants the endpoint may produce.

parameters

val parameters: P

typed parameter tuple captured while building the URI template.

path

val path: List<String>

literal URI segments, with path variables represented separately in parameters.