Student Management System (SMS) Backend

A simple Student Management CRUD API built with Spring Boot, Spring Data JPA, and MySQL.

Technology Stack

• Java 17+
• Spring Boot 3.2.0
• Spring Data JPA (Hibernate)
• MySQL
• Lombok

Setup Instructions

1. Database Setup:

   • Ensure MySQL is running on localhost:3306.
   • Create a database named sms_db (or it will be created automatically if you have permissions).
   • Update src/main/resources/application.properties if your username/password differs from root/root.

2. Build and Run:

   • Using Maven:

     mvn spring-boot:run

   • Or import the project into IntelliJ IDEA / Eclipse and run SmsApplication.java.

API Endpoints

Base URL: http://localhost:8080/api/students

1. Create Student

• POST /api/students
• Body:

  {
    "fullName": "John Doe",
    "email": "john.doe@example.com",
    "phone": "1234567890",
    "branch": "CSE",
    "yop": 2024
  }

2. Get Student by ID

• GET /api/students/{id}

3. List Students (with filtering and pagination)

• GET /api/students?branch=CSE&yop=2024&page=0&size=10
• Params:
  • branch (optional)
  • yop (optional)
  • page (default 0)
  • size (default 10)
  • sortBy (default id)
  • sortDir (default asc)

4. Update Student

• PUT /api/students/{id}
• Body:

  {
    "fullName": "John Doe Updated",
    "email": "john.updated@example.com",
    "phone": "0987654321",
    "branch": "IT",
    "yop": 2025
  }

5. Delete Student

• DELETE /api/students/{id}

Assumptions

• Database credentials are root/root.
• Java 17 or higher is installed.
• Maven is installed or an IDE with Maven support is used.