BFF with YARP, Docker and .NET

Thiago Passos

• 4 min read
BFF with YARP, Docker and .NET

Backend for Frontend (BFF) is a pattern that creates a dedicated backend service for each frontend (e.g., web, mobile) to better optimize API responses, enhance security, and streamline communication between frontends and backend services. In this context, using YARP (Yet Another Reverse Proxy) and Docker can significantly improve routing, scalability, and service orchestration.

Benefits of Combining YARP and Docker in BFF Architecture

  1. Optimized API for Frontends: Each frontend gets a tailored API with BFF, ensuring optimized data delivery, reduced over-fetching, and under-fetching.
  2. Separation of Concerns: BFF handles frontend-specific logic, while YARP manages request routing between multiple services.
  3. Scalability and Flexibility: Docker enables each BFF or backend service to be containerized, making scaling easier.
  4. Service Isolation and Deployment: Docker provides isolation of services, which can then be deployed consistently across various environments.
  5. Routing and Load Balancing: YARP simplifies routing and load balancing between backend services, managed centrally through the BFF.

YARP for BFF

YARP is a customizable reverse proxy that helps in routing frontend requests to backend services. In a BFF architecture, YARP can route frontend requests to appropriate backend services while abstracting complex service interactions from the frontend.

YARP Configuration in BFF

  1. Install YARP NuGet package:

    dotnet add package Microsoft.ReverseProxy --version 1.0.0

  2. Set up YARP routing in appsettings.json:

    {
  "ReverseProxy": {
    "Routes": {
      "route1": {
        "ClusterId": "cluster1",
        "Match": {
          "Path": "/api/service1/{**catch-all}"
        }
      },
      "route2": {
        "ClusterId": "cluster2",
        "Match": {
          "Path": "/api/service2/{**catch-all}"
        }
      }
    },
    "Clusters": {
      "cluster1": {
        "Destinations": {
          "destination1": {
            "Address": "https://backend-service1/api/"
          }
        }
      },
      "cluster2": {
        "Destinations": {
          "destination2": {
            "Address": "https://backend-service2/api/"
          }
        }
      }
    }
  }
}

  3. Configure YARP in Startup.cs:

    public void ConfigureServices(IServiceCollection services)
{
    services.AddReverseProxy()
            .LoadFromConfig(Configuration.GetSection("ReverseProxy"));
}

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    app.UseRouting();
    app.UseEndpoints(endpoints =>
    {
        endpoints.MapReverseProxy();
    });
}

In this setup, YARP efficiently routes requests based on the path patterns (e.g., /api/service1/* is routed to backend-service1, and /api/service2/* is routed to backend-service2).

Dockerizing the BFF

Docker provides a way to package the BFF and other backend services into isolated containers, making the deployment and orchestration of services more manageable and scalable.

Benefits of Dockerizing BFF and Backend Services:

  1. Portability: Docker ensures that your services run consistently across different environments.
  2. Isolation: Each service (BFF, backend services) is isolated, ensuring that they don't interfere with each other.
  3. Scalability: Docker containers can be scaled independently using container orchestration platforms like Kubernetes.

Dockerfile for BFF:

  1. Create a Dockerfile:

    # Use the official ASP.NET Core runtime as a base image
FROM mcr.microsoft.com/dotnet/aspnet:6.0 AS base
WORKDIR /app
EXPOSE 80

# Use the SDK image for building the application
FROM mcr.microsoft.com/dotnet/sdk:6.0 AS build
WORKDIR /src
COPY ["BFF/BFF.csproj", "BFF/"]
RUN dotnet restore "BFF/BFF.csproj"
COPY . .
WORKDIR "/src/BFF"
RUN dotnet build "BFF.csproj" -c Release -o /app/build

FROM build AS publish
RUN dotnet publish "BFF.csproj" -c Release -o /app/publish

FROM base AS final
WORKDIR /app
COPY --from=publish /app/publish .
ENTRYPOINT ["dotnet", "BFF.dll"]

  2. Build the Docker Image:

    docker build -t bff-api .

  3. Run the Docker Container:

    docker run -d -p 8080:80 --name bff-api-container bff-api

By containerizing the BFF, you enable consistent deployment and easy scaling across environments like development, staging, and production.

Docker Compose for Orchestrating Multiple Services

Docker Compose simplifies running multi-container applications, allowing you to define and manage all services (BFF, backend services) in a single file.

docker-compose.yml for BFF and Backend Services:

version: '3'
services:
  bff-api:
    image: bff-api
    build:
      context: .
      dockerfile: Dockerfile
    ports:
      - "8080:80"
    depends_on:
      - backend-service1
      - backend-service2

  backend-service1:
    image: backend-service1
    environment:
      - ASPNETCORE_ENVIRONMENT=Production
    ports:
      - "8081:80"

  backend-service2:
    image: backend-service2
    environment:
      - ASPNETCORE_ENVIRONMENT=Production
    ports:
      - "8082:80"
  1. Run Docker Compose:
    docker-compose up --build

This command builds and runs the BFF and backend services as containers. Docker Compose simplifies orchestration by automatically starting all services, managing dependencies, and exposing the appropriate ports.

Bringing it All Together: YARP + Docker in BFF Architecture

  1. Frontend Requests: Requests from different frontend applications (mobile, web) hit the BFF API.
  2. YARP: The BFF uses YARP to route these requests to the appropriate backend services based on predefined routes.
  3. Docker: The BFF and backend services run inside Docker containers, enabling scalable and consistent deployment across environments. Docker Compose helps orchestrate these services, ensuring smooth communication and interaction.
  4. Scaling and Deployment: With Docker, you can easily scale services horizontally (adding more instances of the BFF or backend services) and deploy them to container orchestration platforms like Kubernetes or Azure Kubernetes Service (AKS).

Pros and Cons of YARP and Docker in BFF

Pros:

  • Optimized for Frontend: BFF provides tailored APIs for each frontend, improving performance and reducing complexity.
  • Scalability: Docker allows for easy scaling of individual services based on traffic.
  • Centralized Routing: YARP efficiently handles routing and load balancing between backend services.
  • Isolation and Portability: Docker ensures services are isolated and can run consistently in different environments.
  • Simplified Deployment: Using Docker Compose simplifies the orchestration and deployment of multi-service applications.

Cons:

  • Complexity: Adding YARP and Docker increases architectural complexity, especially when dealing with multiple services and deployment configurations.
  • Overhead: Docker introduces additional resource overhead, and YARP might add latency due to its role as a proxy layer.
  • Coordination Between Teams: Requires coordination between frontend, backend, and DevOps teams to ensure seamless integration and deployment.

Conclusion

Combining YARP and Docker in a Backend for Frontend (BFF) architecture provides a robust, flexible, and scalable solution. YARP simplifies request routing and load balancing, while Docker enables easy containerization, consistent deployments, and scaling across environments. Using Docker Compose further streamlines service orchestration, making it easier to manage and deploy multiple services. This setup allows for efficient handling of frontend-specific logic while keeping backend services isolated and scalable.