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

@@ -0,0 +1,30 @@
# API Documentation Service
A unified API documentation service that aggregates OpenAPI specifications from all LabFusion services.
## Purpose
- Provide a single entry point for all API documentation
- Aggregate OpenAPI specs from all active services
- Display unified Swagger UI for the entire LabFusion ecosystem
- Monitor service health and availability
## Technology Stack
- **Language**: Node.js
- **Port**: 8083
- **Dependencies**: Express, Swagger UI, Axios
## Features
- **Unified Documentation**: Single Swagger UI for all services
- **Service Health Monitoring**: Real-time status of all services
- **Dynamic Spec Generation**: Automatically fetches and merges OpenAPI specs
- **Service Prefixing**: Each service's endpoints are prefixed for clarity
- **Fallback Handling**: Graceful handling of unavailable services
## API Endpoints
- `GET /` - Swagger UI interface
- `GET /openapi.json` - Unified OpenAPI specification
- `GET /services` - Service health status
- `GET /health` - Documentation service health
## Development Status
**Complete** - Ready for use