Note API Java

Java, Spring Boot implementation for the Note API, a web API to store, retrieve text-based notes.

Technologies

This project uses the following technologies:

• Java 17
• Spring Boot 2.6
• Gradle 7.4
• MongoDB 5
• Project Lombok
• Jackson
• Swagger UI

Testing tools:

• JUnit 5
• AssertJ
• Testcontainers
• Spring integration test configs (see here)
  • @SpringBootTest
  • @WebMvcTest
  • @JsonTest
  • @DataMongoTest

Building the Application

Build dependencies:

• Java 17 JDK
• Docker - used for Testcontainers integration tests

To build the application, run ./gradlew build.

Running the Application

Runtime dependencies:

• Java 17
• MongoDB

To run the application, use java -jar build/libs/note-api.jar

MongoDB

The application is automatically configured to communicate with a local MongoDB instance running on localhost:27017.

You can start up a local MongoDB instance using the provided docker-compose.yaml file, via docker-compose up -d