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

__construct(bool $enabled, ApiEndpointConfig $health, ApiEndpointConfig $openapi, ApiEndpointConfig $docs)

Captures immutable health, OpenAPI and documentation endpoint settings.

bool

Reports whether framework-owned documentation endpoints may be registered.

bool
health()

Returns the health endpoint policy, which remains independent of the global documentation switch.

Returns the OpenAPI specification endpoint policy.

docs()

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.

Parameters

bool $enabled
ApiEndpointConfig $health
ApiEndpointConfig $openapi
ApiEndpointConfig $docs

enabled

bool enabled()

Reports whether framework-owned documentation endpoints may be registered.

Return Value

bool

health

Returns the health endpoint policy, which remains independent of the global documentation switch.

Return Value

ApiEndpointConfig

openApi

Returns the OpenAPI specification endpoint policy.

Return Value

ApiEndpointConfig

docs

Returns the human-readable API documentation endpoint policy.

Return Value

ApiEndpointConfig