How to build SpringBoot MongoDb RestfulApi

I. Technologies

– Java 1.8
– Maven 3.3.9
– Spring Boot: 1.4.3.RELEASE
– Spring Tool Suite – Version 3.8.1.RELEASE
– MongoDB v3.4.1

II. Overview

1. Project Structure

2. Step to do

– Create SpringBoot project
– Create model class
– Create MongoDB Repository
– Run & Check Result

III. Practice

1. Create SpringBoot project

Open Spring Tool Suite, on main menu, choose File->New->Spring Starter Project, input needed project’s info. Press Next, then Finish, a SpringBoot project will be created succesfully.
Open pom.xml file, add Spring Data Rest & Spring Data Mongo dependencies:

 
        org.springframework.boot
        spring-boot-starter-data-rest
    
    
        org.springframework.boot
        spring-boot-starter-data-mongodb
    

2. Create model class

Create a Customer class for simple model:

package com.javasampleapproach.mongodbrestapi.model;

import java.io.Serializable;
import java.util.concurrent.atomic.AtomicLong;

import org.springframework.data.annotation.Id;
import org.springframework.data.annotation.PersistenceConstructor;

 
public class Customer implements Serializable {
 
	private static final long serialVersionUID = 1L;

	@Id
    private Long id;
 
    private String firstName;
 
    private String lastName;
 
    private static AtomicLong COUNTER = new AtomicLong(0L);
    
    @PersistenceConstructor
    public Customer() {
        this.id = COUNTER.incrementAndGet();
    }
 
    @Override
    public String toString() {
        return String.format("Customer[id=%d, firstName='%s', lastName='%s']", id, firstName, lastName);
    }


	public String getFirstName() {
		return firstName;
	}


	public void setFirstName(String firstName) {
		this.firstName = firstName;
	}


	public String getLastName() {
		return lastName;
	}


	public void setLastName(String lastName) {
		this.lastName = lastName;
	}
}

3. Create a MongoDb repository

Create a MongoDb Repository by extends interface MongoRepository:

package com.javasampleapproach.mongodbrestapi.repository;

import java.util.List;

import org.springframework.data.mongodb.repository.MongoRepository;
import org.springframework.data.repository.query.Param;
import org.springframework.data.rest.core.annotation.RepositoryRestResource;

import com.javasampleapproach.mongodbrestapi.model.Customer;

@RepositoryRestResource(collectionResourceRel = "customer", path = "customer")
public interface CustomerRepository extends MongoRepository {
	List findByLastName(@Param("name") String name);
}

In above code, we define a customize method for finding a list customers by lastname.

Open application.properties to configure MongoDB:

spring.data.mongodb.database=restapi
spring.data.mongodb.port=27017

4. Run & Check Result

Run MongoDB Server. Then run Spring Boot project.

GET request:
localhost:8080

localhost:8080/customer

POST request:

GET all Customers:

– All search query:

– Find customers by LastName:

MongoClient

IV. Source code

SpringBootMongoDbRestApi