Add API Documentation Service and enhance existing services with OpenAPI support

This commit is contained in:
glenn schrooyen
2025-09-11 22:24:56 +02:00
parent 21e4972ab1
commit 63b4bb487d
14 changed files with 800 additions and 69 deletions

View File

@@ -52,6 +52,20 @@ LabFusion is a unified dashboard and integration hub for homelab services, built
- Progress tracking document
- Updated project structure documentation
- [x] **API Documentation Service** (2024-11-09)
- Unified Swagger/OpenAPI documentation service
- Aggregates API specs from all services
- Service health monitoring
- Dynamic spec generation with service prefixing
- Express.js service with Swagger UI integration
- [x] **Enhanced Service Adapters** (2024-11-09)
- Comprehensive OpenAPI documentation with Pydantic models
- Detailed request/response schemas for all endpoints
- Service-specific tags and descriptions
- Enhanced error handling with proper HTTP status codes
- Additional endpoints for better service integration
## Current Status 🚧
### Services Directory Structure
@@ -60,13 +74,15 @@ services/
├── api-gateway/ # Java Spring Boot (Port 8080) ✅
├── service-adapters/ # Python FastAPI (Port 8000) ✅
├── metrics-collector/ # Go service (Port 8081) 🚧
── notification-service/ # Node.js service (Port 8082) 🚧
── notification-service/ # Node.js service (Port 8082) 🚧
└── api-docs/ # API Documentation (Port 8083) ✅
```
### Infrastructure
- **Database**: PostgreSQL (Port 5432) ✅
- **Message Bus**: Redis (Port 6379) ✅
- **Frontend**: React (Port 3000) ✅
- **API Documentation**: Unified Swagger UI (Port 8083) ✅
- **Containerization**: Docker Compose ✅
## Next Steps 🎯