WayrApp Backend & Ecosystem Documentation - v1.0.0
    Preparing search index...

    Module WayrappBackend

    Comprehensive Express application configuration for the WayrApp language learning platform backend API.

    This module serves as the central application setup, configuring all middleware, security measures, API routes, and error handling for the entire backend service. The application follows a modular architecture with versioned API endpoints and comprehensive security hardening designed for both traditional server deployments and serverless environments.

    The application implements a complete REST API with hierarchical content structure (Course → Level → Section → Module → Lesson → Exercise) and provides comprehensive authentication, user management, content management, and progress tracking capabilities. It features extensive security middleware including Helmet security headers, CORS configuration, rate limiting, input sanitization, and XSS protection.

    Key architectural features include a dependency injection container for clean service instantiation, comprehensive OpenAPI documentation with interactive examples, performance monitoring middleware, request/response logging, and a global error handler. The application is designed to be deployment- agnostic, supporting both serverless functions (Vercel) and traditional server environments.

    The modular design facilitates future evolution toward a decentralized architecture where different services can be deployed independently across multiple nodes while maintaining backward compatibility. All API endpoints are versioned and include comprehensive documentation accessible via built-in documentation endpoints.

    This application instance serves as the main server entry point, imported by server.ts for deployment and by integration tests for API testing. It forms the foundation for the backend infrastructure, handling requests from multiple frontend clients and preparing for future distributed deployment scenarios.

    Exequiel Trujillo

    1.0.0

    // Used in integration tests for comprehensive API testing
    import request from 'supertest';
    import app from '../../app';

    describe('API Integration Tests', () => {
      it('should return API information', async () => {
        const response = await request(app).get('/api');
        expect(response.status).toBe(200);
        expect(response.body.message).toBe('WayrApp API');
      });

      it('should provide OpenAPI documentation', async () => {
        const response = await request(app).get('/api/docs');
        expect(response.status).toBe(200);
        expect(response.body.openapi).toBe('3.0.0');
      });
    });

    // The app provides comprehensive versioned API endpoints
    // GET /api - API information and capabilities
    // GET /api/docs - Complete OpenAPI 3.0 documentation
    // POST /api/v1/auth/register - User registration
    // POST /api/v1/auth/login - User authentication
    // GET /api/v1/courses - List available courses
    // GET /api/v1/progress - User progress tracking
    // GET /health - Health check endpoint

    Variables

    default

    Settings

    Member Visibility

    On This Page

    Variables