6d7e7f863d
Some checks failed
API Docs (Node.js Express) / test (16) (push) Failing after 5m17s
API Docs (Node.js Express) / test (18) (push) Failing after 5m14s
API Docs (Node.js Express) / test (20) (push) Failing after 55s
API Docs (Node.js Express) / build (push) Has been skipped
API Docs (Node.js Express) / security (push) Has been skipped
LabFusion CI/CD Pipeline / api-gateway (push) Failing after 4m51s
LabFusion CI/CD Pipeline / service-adapters (push) Failing after 5m1s
LabFusion CI/CD Pipeline / api-docs (push) Failing after 5m10s
LabFusion CI/CD Pipeline / frontend (push) Failing after 5m59s
LabFusion CI/CD Pipeline / integration-tests (push) Has been skipped
LabFusion CI/CD Pipeline / security-scan (push) Has been skipped
Docker Build and Push / build-and-push (push) Failing after 33s
Docker Build and Push / security-scan (push) Has been skipped
Integration Tests / integration-tests (push) Failing after 1m55s
Integration Tests / performance-tests (push) Has been skipped
Docker Build and Push / deploy-staging (push) Has been skipped
Docker Build and Push / deploy-production (push) Has been skipped
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 interfaceGET /openapi.json- Unified OpenAPI specificationGET /services- Service health statusGET /health- Documentation service health
Development Status
✅ Complete - Ready for use