85 lines
2.2 KiB
Markdown
85 lines
2.2 KiB
Markdown
# WAG Management API Service v4
|
|
|
|
This service provides a comprehensive API for managing WAG (Wide Area Gateway) systems. It handles configuration, monitoring, and control operations for WAG devices in the network infrastructure.
|
|
|
|
## Quick Start
|
|
|
|
To run the tests using Docker Compose:
|
|
|
|
```bash
|
|
docker compose -f docker-compose.test.yml up --build
|
|
```
|
|
|
|
## Project Structure
|
|
|
|
### Core Services and Components
|
|
|
|
- `Services/` - Core service implementations
|
|
- `PostgresDb/` - PostgreSQL database operations and models
|
|
- `MongoDb/` - MongoDB operations and document models
|
|
- `Redis/` - Redis caching and session management
|
|
- `Email/` - Email notification service
|
|
|
|
- `ApiValidations/` - Request validation and data sanitization
|
|
- Input validation rules
|
|
- Data sanitization filters
|
|
- Schema validation middleware
|
|
|
|
- `ApiLibrary/` - Common utilities and helper functions
|
|
- Shared functions and utilities
|
|
- Common constants and configurations
|
|
- Helper classes and decorators
|
|
|
|
### Configuration and Settings
|
|
|
|
- `AllConfigs/` - Configuration management
|
|
- Database configurations
|
|
- Service settings
|
|
- Environment-specific configs
|
|
|
|
- `Schemas/` - Data models and schema definitions
|
|
- Request/Response models
|
|
- Database schemas
|
|
- API contract definitions
|
|
|
|
### Docker and Deployment
|
|
|
|
- `DockerApiServices/` - API service Docker configurations
|
|
- API service Dockerfile
|
|
- Service dependencies
|
|
|
|
- `DockerStoreServices/` - Storage service Docker configurations
|
|
- Database service Dockerfiles
|
|
- Storage service dependencies
|
|
|
|
### Error Handling and Events
|
|
|
|
- `ErrorHandlers/` - Error handling and exception management
|
|
- Custom exceptions
|
|
- Error handlers
|
|
- Exception middleware
|
|
|
|
- `ApiEvents/` - Event handling and processing
|
|
- Event listeners
|
|
- Event dispatchers
|
|
- Message queue handlers
|
|
|
|
### Language and Testing
|
|
|
|
- `LanguageModels/` - Localization and language support
|
|
- Language files
|
|
- Translation models
|
|
- i18n configurations
|
|
|
|
- `Ztest/` - Test suite
|
|
- Unit tests
|
|
- Integration tests
|
|
- Test fixtures and utilities
|
|
|
|
### Additional Components
|
|
|
|
- `scripts/` - Utility scripts and tools
|
|
- Deployment scripts
|
|
- Database migrations
|
|
- Maintenance utilities
|