How luiiscarlos/academ-iq-api works
Project Type and Purpose
• This is a standalone Spring Boot backend (“Academ IQ API”) that exposes a RESTful API for an educational platform.
• It’s a monolithic, layered service providing user authentication/authorization, course management, enrollments, progress tracking, file storage, and email notifications.
Key Architectural Patterns
• Layered (onion) architecture:
• Controllers (REST endpoints)
• Services (business logic)
• Repositories (data access via Spring Data JPA)
• Models/Entities (JPA) and DTOs
• Security via JWT tokens and servlet filters (filter chain pattern).
• Exception handling via a global exception handler.
Main Components
A. Externals & Clients
• API Clients (Web/Mobile)
• SMTP/Email Service (MailService)
• File storage (local FS or cloud bucket)
• Database (e.g., MySQL/PostgreSQL)
B. API Application (containerized via Docker/Fly.io)
1. Security Layer
– AccessTokenFilter
– ExceptionHandlingFilter
– SecurityConfiguration (HttpSecurity rules)
2. Controllers Layer
– AuthController, UserController, CourseController, EnrollmentController, FileController, RatingController, AdminController
3. Services Layer
– AuthServiceImpl, UserServiceImpl, CourseService, EnrollmentService, FileServiceImpl, RatingService, TokenServiceImpl, MailService, RoleService
4. Persistence Layer
– Repositories: UserRepository, CourseRepository, EnrollmentRepository, FileRepository, RatingRepository, etc.
– Entities and DTOs (models, mappers)
5. Utilities & Config
– RSAKeyProperties & KeyGeneratorUtility (JWT keypair)
– ErrorHandler, UtilConfiguration
Interactions & Data Flows
• Client → HTTP request → Security Filter Chain → Controller → Service → Repository → Database → back up the stack → HTTP response → Client
• Service → MailService → External SMTP
• FileController → FileService → Local/Cloud storage
• TokenService → RSA keys → JWT generation/validation