ApiConfig
final class ApiConfig (View source)
Carries the resolved API runtime policy and its nested security and framework settings.
Methods
Captures immutable API configuration consumed by endpoint registration and middleware.
Reports whether API route registration is enabled.
Returns the normalized path prefix shared by all API endpoints.
Returns application endpoint provider classes in registration order.
Returns the resolved API authentication settings.
Returns the built-in health and documentation endpoint settings.
Details
__construct
__construct(bool $enabled, string $prefix, array $endpointProviders, ApiSecurityConfig $security, FrameworkApiConfig $framework)
Captures immutable API configuration consumed by endpoint registration and middleware.
enabled
bool
enabled()
Reports whether API route registration is enabled.
prefix
string
prefix()
Returns the normalized path prefix shared by all API endpoints.
endpointProviders
array
endpointProviders()
Returns application endpoint provider classes in registration order.
framework
FrameworkApiConfig
framework()
Returns the built-in health and documentation endpoint settings.