MongoDB-Sample

A simple note app. This project helps to explain how to hook up a Spring project to a sample MongoDB Database hosted in an Atlas cluster (cloud-based).

Getting started

Pre-requisites / Dependencies

A mongoDB Atlas account
Postman for the API calls
An IDE to run the app and edit the application.properties file in src/main/resources

In application.properties, change the <VARIABLES> with the correct values. You can create a free cluster with an account at https://www.mongodb.com/cloud/atlas

spring.data.mongodb.database=<DATABASE NAME>
spring.data.mongodb.uri=mongodb+srv://<USER>:<PASSWORD>@<CLUSTER>.lxsu7.mongodb.net/<DATABASE NAME>?retryWrites=true&w=majority

To keep things simpler I have not used DTO mapping and only two API calls for proof of concept. Once your applications.properties is set you should be able to run the app within an IDE.

While the app is running (within an IDE) you can use the following API calls:

/addNote
/findAllNotes

You can test these with Postman - and see the results in your browser (cloud interface) or MongoDB Compass.

Body for /addNote

{
    "noteId": 1,
    "title": "creating a note",
    "body": "the note Id is not the same as mongoDB's objectID, which is still applied"
}

Postman API call and response with a noteId

Postman API call and response without a noteId

/findAllNotes with Postman

The atlas console (via cloud.mongodb.com)

The first note was added via 'insert document' while the other was added via an API call

You can see the additional notes added via API calls