type

Endpoint

One application-authored method and path handler mounted at root, collection, or global scope.

Properties

PropertyTypeDescription
MethodstringCONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, or PUT.
PathstringA leading-slash path with optional complete :parameter segments.
SummarystringOptional generated OpenAPI operation summary.
MaxBodyBytesint64Raw body bound; zero inherits HandlerOptions and a negative value opts trusted streaming out.
HandlerEndpointHandlerTrusted compiled application handler code.

How it works

Root endpoints mount below /api. Collection and global endpoints mount below their resource route and run before a matching built-in route for the same method.

Custom endpoints are anonymous by default. Handler must enforce endpoint-specific authorization.

Full signature