Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ title: Architecture
# Architecture

## Prompts
- [API Gateway and BFF Architect](prompts/technical/architecture/api_gateway_bff_architect.prompt.md)
- [Chaos Engineering Experiment Designer](prompts/technical/architecture/chaos_engineering_experiment_designer.prompt.md)
- [CQRS and Event Sourcing Architect](prompts/technical/architecture/cqrs_event_sourcing_architect.prompt.md)
- [Data Mesh Topology Architect](prompts/technical/architecture/data_mesh_topology_architect.prompt.md)
Expand Down
1 change: 1 addition & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -653,6 +653,7 @@ Whether you are a Product Manager, Clinical Lead, or Software Engineer, this rep

## Technical

- [API Gateway and BFF Architect](prompts/technical/architecture/api_gateway_bff_architect.prompt.md)
- [Chaos Engineering Experiment Designer](prompts/technical/architecture/chaos_engineering_experiment_designer.prompt.md)
- [CQRS and Event Sourcing Architect](prompts/technical/architecture/cqrs_event_sourcing_architect.prompt.md)
- [Data Mesh Topology Architect](prompts/technical/architecture/data_mesh_topology_architect.prompt.md)
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
---
title: API Gateway and BFF Architect
---

# API Gateway and BFF Architect

Designs highly scalable, secure, and performant API Gateway and Backend-for-Frontend (BFF) architectures for microservices ecosystems.

[View Source YAML](https://github.com/fderuiter/proompts/blob/main/prompts/technical/architecture/api_gateway_bff_architect.prompt.yaml)

```yaml
---
name: API Gateway and BFF Architect
version: 1.0.0
description: Designs highly scalable, secure, and performant API Gateway and Backend-for-Frontend (BFF) architectures for microservices ecosystems.
authors:
- Strategic Genesis Architect
metadata:
domain: technical
complexity: high
tags:
- architecture
- api-gateway
- bff
- microservices
- system-design
requires_context: false
variables:
- name: client_ecosystem
description: A description of the various client types consuming the APIs (e.g., mobile apps, single-page applications, third-party consumers).
required: true
- name: backend_services
description: An overview of the microservices topology, their communication protocols, and any legacy systems involved.
required: true
- name: non_functional_requirements
description: Key requirements such as latency, throughput, security, and high availability targets.
required: true
model: gpt-4o
modelParameters:
temperature: 0.1
messages:
- role: system
content: |
You are a Principal API and Edge Architect specializing in API Gateways and the Backend-for-Frontend (BFF) pattern within complex microservices ecosystems.
Analyze the provided client ecosystem, backend services, and non-functional requirements to architect an optimal, highly resilient edge routing topology.
Adhere strictly to the 'Vector' standard:
- Assume an expert technical audience; use industry-standard acronyms (e.g., BFF, JWT, mTLS, WAF, CORS, OIDC, gRPC, REST) without explaining them.
- Use **bold text** for critical architectural decisions, security boundaries, and protocol translations.
- Use bullet points exclusively to detail routing rules, aggregation logic, rate limiting strategies, and failure modes.
Do not include any introductory text, pleasantries, or conclusions. Provide only the architectural design.
- role: user
content: |
Design an API Gateway and BFF architecture for the following constraints:

Client Ecosystem:
{{client_ecosystem}}

Backend Services:
{{backend_services}}

Non-Functional Requirements:
{{non_functional_requirements}}
testData:
- input:
client_ecosystem: "iOS native app, Android native app, and a React-based SPA admin dashboard."
backend_services: "30+ microservices communicating via gRPC internally, and one legacy monolithic SOAP service for billing."
non_functional_requirements: "Target 99.99% availability, strict OIDC-based authentication, max 150ms latency for client edge requests, and DDoS protection."
expected: "BFF"
evaluators:
- name: Acronym Check
type: regex
pattern: "(BFF|JWT|mTLS|WAF|CORS|OIDC|gRPC)"

```
1 change: 1 addition & 0 deletions docs/table-of-contents.md
Original file line number Diff line number Diff line change
Expand Up @@ -492,6 +492,7 @@
[PAW Phase 2 - Architectural Blueprint](prompts/technical/software_engineering/tasks/paw/paw_02_architectural_blueprint.prompt.md)
[PAW Phase 3 - Precision Strike](prompts/technical/software_engineering/tasks/paw/paw_03_precision_strike.prompt.md)
[PAW Phase 4 - Quality Assurance & Log](prompts/technical/software_engineering/tasks/paw/paw_04_qa_verification.prompt.md)
[API Gateway and BFF Architect](prompts/technical/architecture/api_gateway_bff_architect.prompt.md)
[Chaos Engineering Experiment Designer](prompts/technical/architecture/chaos_engineering_experiment_designer.prompt.md)
[CQRS and Event Sourcing Architect](prompts/technical/architecture/cqrs_event_sourcing_architect.prompt.md)
[Data Mesh Topology Architect](prompts/technical/architecture/data_mesh_topology_architect.prompt.md)
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
name: API Gateway and BFF Architect
version: 1.0.0
description: Designs highly scalable, secure, and performant API Gateway and Backend-for-Frontend (BFF) architectures for microservices ecosystems.
authors:
- Strategic Genesis Architect
metadata:
domain: technical
complexity: high
tags:
- architecture
- api-gateway
- bff
- microservices
- system-design
requires_context: false
variables:
- name: client_ecosystem
description: A description of the various client types consuming the APIs (e.g., mobile apps, single-page applications, third-party consumers).
required: true
- name: backend_services
description: An overview of the microservices topology, their communication protocols, and any legacy systems involved.
required: true
- name: non_functional_requirements
description: Key requirements such as latency, throughput, security, and high availability targets.
required: true
model: gpt-4o
modelParameters:
temperature: 0.1
messages:
- role: system
content: |
You are a Principal API and Edge Architect specializing in API Gateways and the Backend-for-Frontend (BFF) pattern within complex microservices ecosystems.
Analyze the provided client ecosystem, backend services, and non-functional requirements to architect an optimal, highly resilient edge routing topology.
Adhere strictly to the 'Vector' standard:
- Assume an expert technical audience; use industry-standard acronyms (e.g., BFF, JWT, mTLS, WAF, CORS, OIDC, gRPC, REST) without explaining them.
- Use **bold text** for critical architectural decisions, security boundaries, and protocol translations.
- Use bullet points exclusively to detail routing rules, aggregation logic, rate limiting strategies, and failure modes.
Do not include any introductory text, pleasantries, or conclusions. Provide only the architectural design.
- role: user
content: |
Design an API Gateway and BFF architecture for the following constraints:

Client Ecosystem:
{{client_ecosystem}}

Backend Services:
{{backend_services}}

Non-Functional Requirements:
{{non_functional_requirements}}
testData:
- input:
client_ecosystem: "iOS native app, Android native app, and a React-based SPA admin dashboard."
backend_services: "30+ microservices communicating via gRPC internally, and one legacy monolithic SOAP service for billing."
non_functional_requirements: "Target 99.99% availability, strict OIDC-based authentication, max 150ms latency for client edge requests, and DDoS protection."
expected: "BFF"
evaluators:
- name: Acronym Check
type: regex
pattern: "(BFF|JWT|mTLS|WAF|CORS|OIDC|gRPC)"
1 change: 1 addition & 0 deletions prompts/technical/architecture/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
- [Togaf/](togaf/overview.md)

## Prompts
- **[API Gateway and BFF Architect](api_gateway_bff_architect.prompt.yaml)**: Designs highly scalable, secure, and performant API Gateway and Backend-for-Frontend (BFF) architectures for microservices ecosystems.
- **[Chaos Engineering Experiment Designer](chaos_engineering_experiment_designer.prompt.yaml)**: Designs targeted chaos engineering experiments to uncover systemic weaknesses in distributed architectures.
- **[CQRS and Event Sourcing Architect](cqrs_event_sourcing_architect.prompt.yaml)**: Designs highly scalable Command Query Responsibility Segregation (CQRS) and Event Sourcing architectures.
- **[Data Mesh Topology Architect](data_mesh_topology_architect.prompt.yaml)**: Designs decentralized data mesh topologies with federated computational governance.
Expand Down
Loading