Add API Documentation Service and enhance existing services with OpenAPI support
This commit is contained in:
30
services/api-docs/README.md
Normal file
30
services/api-docs/README.md
Normal 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
|
||||
Reference in New Issue
Block a user