How lapluu1196/ims-project works
Main Components
• Backend Application Server – Represent the Spring Boot application as the core of the architecture.
• REST API Layer – Indicate the API endpoints which are served by various controllers (e.g., global controllers, auth controllers, candidate controllers, interview schedule controllers, job controllers, offer controllers, user controllers).
• Service Layer – Show the business logic handled by services and their implementations (e.g., CandidateService, JobService, UserService, InterviewScheduleService, etc.).
• Data Access Layer – Represent the repository classes interfacing with entities (e.g., CandidateRepository, InterviewScheduleRepository, and others).
• Domain Model – Outline key entities such as Candidate, InterviewSchedule, Job, Offer, User, etc.
• Security/Authentication Module – Highlight JWT configuration and related classes (JwtConfig, JwtAuthenticationFilter, RefreshTokenService) that manage authentication and authorization.
• Configuration & Exception Handling – Include components for application-wide configurations (SecurityConfig, OpenApiConfig, RedisConfig, CustomErrorPageConfig) and exception handling (GlobalExceptionHandler, custom exception classes).
• API Documentation – Indicate the integration of Swagger for API documentation.
• Containerization & Deployment – Show the containerization aspect via the Dockerfile and docker-compose, as well as the deployment target (Azure VPS).
Relationships and Interactions
• The Security Module should be depicted as a cross-cutting concern intercepting incoming requests and handling JWT-based authentication.
• Interactions between configuration components and the core modules; for instance, Swagger/OpenAPI configurations that automatically generate API docs and error-handling configurations that redirect to appropriate error pages.
Architectural Patterns and Design Principles
• Separation of concerns: distinct modules for authentication, error handling, and business logic.
• How DTOs (Data Transfer Objects) are used to transfer data, which promotes loose coupling between controllers and the domain model.
Technologies and Their Roles
• Spring Boot – The foundation framework for building the REST API.
• JWT – Securing API endpoints for authentication.
• Swagger – Providing interactive API documentation.
• Docker & docker-compose – Containerizing the application to simplify deployment on an Azure VPS.
• Maven – For building and managing dependencies.
Final Touches
• To include external integrations such as Swagger (accessible via a defined URL) and the API’s interaction points, emphasizing scalability and security features.