af33bc2d20
Some checks failed
Docker Build and Push / setup (push) Successful in 54s
API Docs (Node.js Express) / test (20) (push) Failing after 3m4s
API Docs (Node.js Express) / build (push) Has been skipped
Integration Tests / integration-tests (push) Failing after 2m31s
Integration Tests / performance-tests (push) Has been skipped
API Gateway (Java Spring Boot) / test (21) (push) Failing after 4m18s
API Gateway (Java Spring Boot) / test (17) (push) Failing after 4m19s
API Gateway (Java Spring Boot) / build (push) Has been skipped
Service Adapters (Python FastAPI) / test (3.11) (push) Failing after 1m51s
Docker Build and Push / build-push-service-adapters (push) Successful in 1m15s
Service Adapters (Python FastAPI) / test (3.13) (push) Failing after 1m58s
Service Adapters (Python FastAPI) / test (3.12) (push) Failing after 3m17s
Service Adapters (Python FastAPI) / build (push) Has been skipped
Docker Build and Push / build-push-api-docs (push) Successful in 52s
Docker Build and Push / build-push-frontend (push) Successful in 45s
Docker Build and Push / build-push-api-gateway (push) Successful in 10m4s
49 lines
1.5 KiB
Markdown
49 lines
1.5 KiB
Markdown
# API Gateway Service
|
|
|
|
The core API gateway for LabFusion, built with Java Spring Boot following clean code principles.
|
|
|
|
## Purpose
|
|
- Central API endpoint for all frontend requests
|
|
- User authentication and authorization
|
|
- Dashboard and widget management
|
|
- Event and device state storage
|
|
- System metrics and health monitoring
|
|
|
|
## Technology Stack
|
|
- **Language**: Java 17
|
|
- **Framework**: Spring Boot 3.2.0
|
|
- **Port**: 8080
|
|
- **Database**: PostgreSQL
|
|
- **Message Bus**: Redis
|
|
- **Documentation**: OpenAPI/Swagger
|
|
- **Testing**: JUnit 5, Mockito
|
|
- **Quality**: SpotBugs, Checkstyle, PMD, JaCoCo
|
|
|
|
## Features
|
|
- JWT-based authentication framework
|
|
- RESTful API endpoints with comprehensive documentation
|
|
- WebSocket support for real-time updates
|
|
- Dashboard CRUD operations
|
|
- Event and device state management
|
|
- System health monitoring
|
|
- OpenAPI documentation generation
|
|
- Comprehensive error handling
|
|
- Clean code architecture with layered design
|
|
|
|
## Architecture
|
|
- **Controller Layer**: REST endpoints with validation
|
|
- **Service Layer**: Business logic and orchestration
|
|
- **Repository Layer**: Data access abstraction
|
|
- **Model Layer**: JPA entities and DTOs
|
|
- **Configuration**: Spring Boot auto-configuration
|
|
|
|
## API Endpoints
|
|
- `GET /actuator/health` - Health check
|
|
- `GET /swagger-ui.html` - API documentation
|
|
- `GET /api/dashboards` - Dashboard management
|
|
- `GET /api/system/metrics` - System metrics
|
|
- `POST /api/events` - Event publishing
|
|
|
|
## Development Status
|
|
✅ **Complete** - Core functionality implemented with clean code principles
|