Files
labFusion/services/api-docs
GSRN 48c755dff3
Some checks failed
Integration Tests / integration-tests (push) Failing after 24s
Integration Tests / performance-tests (push) Has been skipped
API Docs (Node.js Express) / test (20) (push) Failing after 42s
API Docs (Node.js Express) / build (push) Has been skipped
Service Adapters (Python FastAPI) / test (3.11) (push) Successful in 1m8s
Service Adapters (Python FastAPI) / test (3.12) (push) Successful in 1m13s
Frontend (React) / test (20) (push) Successful in 1m46s
Frontend (React) / build (push) Failing after 52s
Frontend (React) / lighthouse (push) Has been skipped
Service Adapters (Python FastAPI) / test (3.13) (push) Successful in 2m4s
Service Adapters (Python FastAPI) / build (push) Failing after 17s
feat: Enhance frontend with theme support and offline capabilities
### Summary of Changes
- Introduced theme-aware CSS variables for consistent styling across light and dark modes.
- Updated `App.jsx` to manage theme settings and improve layout responsiveness.
- Refactored `OfflineMode` component to provide detailed connection status and quick actions for users.
- Enhanced `Dashboard`, `Settings`, and `SystemMetrics` components to utilize new theme variables and improve UI consistency.
- Updated service URLs in constants and API documentation to reflect new configurations.

### Expected Results
- Improved user experience with a cohesive design that adapts to user preferences.
- Enhanced offline functionality, providing users with better feedback and control during service outages.
- Streamlined codebase with consistent styling practices, making future updates easier.
2025-09-18 02:37:58 +02:00
..
2025-09-17 23:41:26 +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 with comprehensive testing and clean code implementation

Testing

  • Unit Tests: Jest test suite with comprehensive coverage
  • Coverage: Test coverage reporting
  • CI/CD: Automated testing in Gitea Actions pipeline
  • Quality: ESLint code quality checks

Clean Code Implementation

  • Single Purpose: Focused on OpenAPI spec aggregation
  • Error Handling: Graceful degradation when services are unavailable
  • Caching: Performance optimization with intelligent caching
  • Health Monitoring: Real-time service status tracking
  • Configuration: Environment-based settings management
  • Documentation: Comprehensive inline documentation