Admin Backend-for-Frontend
Overview
The AdminBFF (Backend-for-Frontend) service is the administrative gateway that bridges the Angular-based front-end application with the internal service ecosystem. It serves as the single public-facing backend entry point for all administrative operations, providing a tightly controlled interface that enforces security, authorization, and request routing policies.
- API Gateway for Front-End: Acts as the dedicated backend interface for the admin UI, simplifying and consolidating access to internal services.
- Reverse Proxy via YARP: Uses YARP (Yet Another Reverse Proxy) to intelligently route and proxy requests to internal backend services. This enables seamless service composition, service path rewriting, and centralized traffic control.
- Authorization Enforcement: Validates that all incoming requests are made by authenticated users with the proper roles and scopes. It serves as the first and last line of defense before internal services are reached, ensuring that only authorized actions are executed.
- Facade for Backend Complexity: Exposes a front-end-optimized API layer, reducing the need for the UI to manage low-level backend details or coordinate multiple service calls directly.
- Config File Serving for Admin UI: AdminBFF also serves a runtime configuration file used by the Angular-based Admin UI service. This allows environment-specific values (e.g. API base URLs, feature flags) to be injected at deployment time.
Configuration
| Property | Type | Description |
|---|---|---|
Redis:Enabled |
boolean | If enabled, Redis will be used to cache account information associated with authenticated users. |
OpenAPI Operations
Route Parameters
None
Query Parameters
None
Get Report Summaries
Route Parameters
None
Query Parameters
| Name | Type | Required? | Description |
|---|---|---|---|
| facilityId | string | No | |
| pageNumber | integer (int32) | No | |
| pageSize | integer (int32) | No |
System Health Check
Route Parameters
None
Query Parameters
None
Integration Testing - Produce Patient Event
Route Parameters
None
Query Parameters
None
Integration Testing - Produce Report Scheduled Event
Route Parameters
None
Query Parameters
None
Integration Testing - Produce Data Acquisition Requested Event
Route Parameters
None
Query Parameters
None
Integration Testing - Produce Data Acquisition Requested Event
Route Parameters
None
Query Parameters
None
Integration Testing - Start Consumers
Route Parameters
None
Query Parameters
None
Integration Testing - Read Consumers
Route Parameters
None
Query Parameters
None
Integration Testing - Stop Consumers.
Route Parameters
None
Query Parameters
None
Relationships
flowchart LR
nAdminBFF_4D4F63E2["Service: Admin Backend-for-Frontend"]
nAdminBFF_4D4F63E2 -->|provides| nGetFacilitiesList_5CEDF833["Query: GetFacilitiesList"]
nAdminBFF_4D4F63E2 -->|provides| nGetFacilityConfig_32C58A79["Query: GetFacilityConfig"]
nAdminBFF_4D4F63E2 -->|provides| nGetServiceInfo_13F02E06["Query: GetServiceInfo"]
subgraph nTenant_379CD514_domain["Domain: Tenant"]
nGetFacilitiesList_5CEDF833
nGetFacilityConfig_32C58A79
nGetServiceInfo_13F02E06
end