FrameworkApiConfig
final class FrameworkApiConfig (View source)
Groups the resolved registration policies for framework-owned API endpoints.
Health remains independently configurable when the other framework endpoints are disabled.
Methods
Captures immutable health, OpenAPI and documentation endpoint settings.
Reports whether framework-owned documentation endpoints may be registered.
Returns the health endpoint policy, which remains independent of the global documentation switch.
Returns the OpenAPI specification endpoint policy.
Returns the human-readable API documentation endpoint policy.
Details
__construct
__construct(bool $enabled, ApiEndpointConfig $health, ApiEndpointConfig $openapi, ApiEndpointConfig $docs)
Captures immutable health, OpenAPI and documentation endpoint settings.
enabled
bool
enabled()
Reports whether framework-owned documentation endpoints may be registered.
health
ApiEndpointConfig
health()
Returns the health endpoint policy, which remains independent of the global documentation switch.