stefan
9282dd0eb4
1. **Dokumentation der Architektur:**
- Vervollständigen Sie die C4-Diagramme im docs-Verzeichnis
- Dokumentieren Sie die wichtigsten Architekturentscheidungen in ADRs
2. **Redis-Integration finalisieren:**
- Implementieren Sie die verteilte Cache-Lösung für die Offline-Fähigkeit
- Nutzen Sie Redis Streams für das Event-Sourcing
4.3 KiB
ADR-0007: API Gateway Pattern
Status
Accepted
Context
With our microservices architecture (ADR-0003), we faced several challenges related to client-service communication:
- Clients would need to know the locations and interfaces of multiple services
- Different clients (web, desktop, mobile) would need to make multiple calls to different services
- Authentication and authorization would need to be implemented consistently across all services
- Cross-cutting concerns like rate limiting, logging, and monitoring would need to be implemented in each service
- API versioning and backward compatibility would need to be managed across all services
- Network security would be more complex with multiple services exposed directly
We needed a solution that would simplify client-service communication while addressing these challenges.
Decision
We decided to implement the API Gateway pattern using Ktor as the framework. The API Gateway serves as the single entry point for all client requests and provides the following functionality:
- Request Routing: Routes requests to the appropriate microservices
- Authentication and Authorization: Integrates with Keycloak (ADR-0006) to authenticate users and validate tokens
- Rate Limiting: Prevents abuse by limiting the number of requests from a single client
- Request/Response Transformation: Transforms requests and responses as needed for different clients
- Logging and Monitoring: Provides centralized logging and monitoring of all API requests
- Caching: Caches responses to improve performance
- API Documentation: Hosts OpenAPI documentation for all services
- Service Discovery: Discovers service instances dynamically
Our implementation includes:
- A Ktor-based API Gateway deployed as a containerized service
- Integration with Keycloak for authentication and authorization
- Custom plugins for rate limiting, logging, and monitoring
- OpenAPI documentation generation
- Service discovery integration
Consequences
Positive
- Simplified client development: Clients only need to communicate with a single endpoint
- Consistent security: Authentication and authorization are handled consistently
- Centralized cross-cutting concerns: Rate limiting, logging, and monitoring are implemented once
- Improved security: Internal services are not exposed directly to clients
- Flexibility: The gateway can adapt requests and responses for different clients
Negative
- Single point of failure: The gateway becomes a critical component that must be highly available
- Performance overhead: Requests go through an additional network hop
- Complexity: The gateway needs to handle a wide range of functionality
- Development bottleneck: Changes to the gateway may require coordination across teams
Neutral
- Deployment considerations: The gateway needs to be deployed and scaled appropriately
- Versioning strategy: API versioning still needs to be managed, albeit in one place
Alternatives Considered
Direct Client-to-Service Communication
We considered allowing clients to communicate directly with services. This would have eliminated the network hop through the gateway but would have made client development more complex and would have required implementing cross-cutting concerns in each service.
Backend for Frontend (BFF) Pattern
We considered implementing separate Backend for Frontend (BFF) services for each client type. This would have allowed for more client-specific optimizations but would have increased development and operational overhead.
Service Mesh
We considered using a service mesh like Istio or Linkerd to handle service-to-service communication. This would have provided many of the same benefits for service-to-service communication but would not have addressed the client-to-service communication challenges as effectively.