Files
labFusion/services/api-docs
glenn schrooyen 8c87c84208
Some checks failed
API Docs (Node.js Express) / test (16) (push) Failing after 5m42s
API Docs (Node.js Express) / test (20) (push) Has been cancelled
API Docs (Node.js Express) / build (push) Has been cancelled
API Docs (Node.js Express) / security (push) Has been cancelled
API Docs (Node.js Express) / test (18) (push) Has been cancelled
LabFusion CI/CD Pipeline / api-gateway (push) Has been cancelled
LabFusion CI/CD Pipeline / service-adapters (push) Has been cancelled
LabFusion CI/CD Pipeline / api-docs (push) Has been cancelled
LabFusion CI/CD Pipeline / frontend (push) Has been cancelled
LabFusion CI/CD Pipeline / integration-tests (push) Has been cancelled
LabFusion CI/CD Pipeline / security-scan (push) Has been cancelled
Docker Build and Push / build-and-push (push) Has been cancelled
Docker Build and Push / security-scan (push) Has been cancelled
Docker Build and Push / deploy-staging (push) Has been cancelled
Docker Build and Push / deploy-production (push) Has been cancelled
Frontend (React) / test (16) (push) Has been cancelled
Frontend (React) / test (18) (push) Has been cancelled
Frontend (React) / test (20) (push) Has been cancelled
Frontend (React) / build (push) Has been cancelled
Frontend (React) / lighthouse (push) Has been cancelled
Frontend (React) / security (push) Has been cancelled
Integration Tests / performance-tests (push) Has been cancelled
Service Adapters (Python FastAPI) / security (push) Has been cancelled
Service Adapters (Python FastAPI) / test (3.1) (push) Has been cancelled
Service Adapters (Python FastAPI) / test (3.11) (push) Has been cancelled
Service Adapters (Python FastAPI) / test (3.12) (push) Has been cancelled
Service Adapters (Python FastAPI) / test (3.9) (push) Has been cancelled
Service Adapters (Python FastAPI) / build (push) Has been cancelled
Integration Tests / integration-tests (push) Has been cancelled
Update CI workflows for Python linting by increasing flake8 line length limit to 150 characters for better readability; adjust service-adapters.yml and ci.yml accordingly; update progress documentation
2025-09-12 22:42:47 +02:00
..

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