ApiEndpointConfig
final class ApiEndpointConfig (View source)
Captures the resolved route and authorization policy for one framework-owned API endpoint.
Methods
Initializes an immutable endpoint policy consumed during framework endpoint registration.
Reports whether the framework should register this endpoint.
Returns the endpoint path relative to the configured API prefix.
Returns the authentication boundary enforced before endpoint dispatch.
Returns every scope required after the endpoint access boundary is satisfied.
Details
__construct
__construct(bool $enabled, string $route, ApiAccess $access, array $scopes = [])
Initializes an immutable endpoint policy consumed during framework endpoint registration.
enabled
bool
enabled()
Reports whether the framework should register this endpoint.
route
string
route()
Returns the endpoint path relative to the configured API prefix.
access
ApiAccess
access()
Returns the authentication boundary enforced before endpoint dispatch.
scopes
array
scopes()
Returns every scope required after the endpoint access boundary is satisfied.