Angularity

Core
Overview Exceptions Type Container Type-safe Providing
CDK
Overview Breakpoints
API References
endpoints / Interface

EndpointSchema

Declaration schema of an API endpoint.

Properties

NameTypeDescription
method
string

The method to be used for invoking the endpoint. The definition of "method" may vary depending on the concrete EndpointInvoker implementation.

params
EndpointParamsSchema | null

Declaration of acceptable parameters of the endpoint if any, used primarily for type-inference at our end.

path
string

Path of the target API endpoint. The definition and format of "path" may vary depending on the concrete EndpointInvoker implementation.

response
TypeContainer<unknown>

Declaration of the expected response of the endpoint, used primarily for type-inference at our end.