Skip to content

Commit 30fb91e

Browse files
committed
feat: enhance documentation for internal operational SPA with detailed BFF layer description
1 parent 882ec93 commit 30fb91e

File tree

2 files changed

+17
-2
lines changed

2 files changed

+17
-2
lines changed

src/content/en-case-studies/internal-operational-spa.mdx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The application acts as a **single-page interface** for day-to-day operational t
2525
- managing staff members and their roles,
2626
- browsing and inspecting service points,
2727
- viewing operational status and assignments,
28-
- interacting with data exposed by backend systems through a BFF layer.
28+
- interacting with data exposed by backend systems through **a dedicated BFF layer designed and implemented as part of the project.**
2929

3030
The system was designed from the start as:
3131
- an **internal tool**, not a public-facing application,
@@ -81,6 +81,9 @@ Key requirements included:
8181

8282
The frontend had to remain **contract-agnostic** while still enforcing strong operational guarantees.
8383

84+
The BFF was treated as a first-class component of the frontend architecture,
85+
designed and implemented alongside the SPA to provide stable contracts and isolate backend complexity.
86+
8487
---
8588

8689
### 4. Long-term evolution under active use
@@ -207,6 +210,7 @@ _UI screenshots shown with anonymized data and removed branding._
207210
The frontend integrates with backend systems using:
208211
- REST over HTTP with JSON payloads,
209212
- same-origin API paths exposed by a BFF layer,
213+
- a dedicated BFF layer designed and implemented together with the SPA,
210214
- OAuth2 / OpenID Connect authentication (Authorization Code + PKCE).
211215

212216
Key characteristics:
@@ -218,6 +222,8 @@ Key characteristics:
218222

219223
UI components remain **decoupled from API details**, relying on a centralized integration layer.
220224

225+
The BFF is responsible for shaping backend responses into frontend-oriented contracts and enforcing consistency across multiple backend systems.
226+
221227
---
222228

223229
## State management and reliability

src/content/pl-case-studies/internal-operational-spa.mdx

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Aplikacja pełni rolę **interfejsu typu single-page** do codziennych zadań ope
2525
- zarządzanie pracownikami i ich rolami,
2626
- przeglądanie i analiza punktów usługowych,
2727
- podgląd statusów operacyjnych i przypisań,
28-
- interakcja z danymi udostępnianymi przez systemy backendowe poprzez warstwę BFF.
28+
- interakcję z danymi udostępnianymi przez systemy backendowe za pośrednictwem ***dedykowanej warstwy BFF zaprojektowanej i zaimplementowanej jako część projektu.**
2929

3030
System od początku projektowany był jako:
3131
- **narzędzie wewnętrzne**, a nie aplikacja publiczna,
@@ -81,6 +81,10 @@ Kluczowe wymagania obejmowały:
8181

8282
Frontend musiał pozostać **agnostyczny względem kontraktów**, jednocześnie egzekwując silne gwarancje operacyjne.
8383

84+
Warstwa BFF była traktowana jako pełnoprawny element architektury frontendowej,
85+
projektowana i implementowana równolegle z aplikacją SPA w celu zapewnienia stabilnych kontraktów
86+
oraz izolacji złożoności systemów backendowych.
87+
8488
---
8589

8690
### 4. Długoterminowa ewolucja przy aktywnym użyciu
@@ -207,6 +211,7 @@ _Zrzuty UI prezentowane są z anonimizowanymi danymi i usuniętym brandingiem._
207211
Frontend integruje się z systemami backendowymi poprzez:
208212
- REST over HTTP z payloadami JSON,
209213
- ścieżki API typu same-origin wystawione przez warstwę BFF,
214+
- dedykowaną warstwę BFF zaprojektowaną i zaimplementowaną równolegle z aplikacją SPA,
210215
- uwierzytelnianie OAuth2 / OpenID Connect (Authorization Code + PKCE).
211216

212217
Kluczowe cechy:
@@ -218,6 +223,10 @@ Kluczowe cechy:
218223

219224
Komponenty UI pozostają **odsprzężone od szczegółów API**, korzystając ze scentralizowanej warstwy integracji.
220225

226+
Warstwa BFF odpowiada za kształtowanie odpowiedzi systemów backendowych
227+
do kontraktów dopasowanych do potrzeb frontendu oraz za wymuszanie spójności
228+
pomiędzy wieloma systemami backendowymi.
229+
221230
---
222231

223232
## Zarządzanie stanem i niezawodność

0 commit comments

Comments
 (0)