This project demonstrates how to integrate MongoDB with Spring Boot, covering a wide range of data access patterns—from simple CRUD to advanced aggregation pipelines. It’s designed as a learning repository, providing both code samples and tests to help you master MongoDB usage in a Spring ecosystem.
- CRUD Operations (Create, Read, Update, Delete)
- Pagination & Sorting via Spring Data Pageable
- Derived Query Methods: And, Or, In, Like, TopN
- Custom @Query methods with raw JSON (regex, text search)
- Aggregation Pipelines using MongoTemplate ($unwind, $group, $lookup)
- DBRef & Joins via $lookup
- Transient Fields & computed properties
- Docker Compose for MongoDB setup
- Integration Testing: @DataMongoTest + Testcontainers
- Java17 or higher
- Maven (or Gradle)
- Docker (for MongoDB)
- Postman (optional, for API testing)
- Clone the repository
git clone https://github.com/your-org/spring-boot-with-mongodb.git cd spring-boot-with-mongodb - Start MongoDB via Docker Compose
docker-compose up -d
- Build & run the application
mvn clean install mvn spring-boot:run
The REST API will be available at http://localhost:8888/api/v1/students
- MongoDB URI: configured in src/main/resources/application.yml
spring: data: mongodb: uri: mongodb://localhost:27017/studentdb
- Docker Compose definition in docker-compose.yml launches a mongo:latest container.
| HTTP Method | Path | Description | Concepts |
|---|---|---|---|
| POST | / | Create a new Student | CRUD |
| GET | / | List Students (page, size, sort, dir) | Pagination & Sorting |
| GET | /{id} | Get Student by ID | CRUD |
| PUT | /{id} | Update Student | CRUD |
| DELETE | /{id} | Delete Student | CRUD |
| GET | /active | List Active Students | Derived Query (findByActiveTrue) |
| GET | //active/by-department/{deptId} | List Active Students by dept using compound index | Derived Query (findByDepartment_IdAndActiveTrue) |
| GET | /count-active | Count Active Students | Derived Query (countByActiveTrue) |
| GET | /exists?email= | Check existence by email | Derived Query (existsByEmail) |
| GET | /searchByName?name= | Regex search on first/last name | Custom @Query (regex) |
| GET | /search/{text} | Text-indexed based search | Derived @Query (findAllBy) |
| GET | /by-course?courseName= | Students by Course name | Derived Query (findByCoursesName) |
| GET | /high-scorers?courseName=&minScore= | Students scoring ≥ minScore in course | Derived Query (compound) |
| GET | /by-department/{deptId} | Students in Department | Derived Query (findByDepartment_Id) |
| GET | /born-between?start=&end= | Students born in date range | Derived Query (findByDobBetween) |
| GET | /recent-enrollments | Top 5 recent enrollments | Derived Query (findTop5ByOrderBy...) |
- Add mongodb test-container for testing repositories
- Create aggregation pipeline endpoints:
- GET /agg/avg-marks (average marks per course)
- GET /agg/count-by-dept (student count by department)
- GET /lookup (join students with departments)
Import the Postman collection to explore and test the API:
🤝 Contributing
- Fork the repo
- Create a feature branch
- Write tests for new features
- Submit a pull request