House-keep + docs updates

Author: giri-jeedigunta

Dockerfile

@@ -1,10 +1,13 @@
+# Author: Giri Jeedigunta
+# Git: https://github.com/giri-jeedigunta/java-spring-mongo-starter-reactive
+
 FROM openjdk:14-jdk-alpine
 
 WORKDIR /app
 
-ADD build/libs/*.jar ReactiveRESTStarterApp-1.0.jar
+ADD build/libs/*.jar ReactiveRESTfulStarterApp-1.0.jar
 
-EXPOSE 8083
+EXPOSE 4000
 
 ENV JAVA_XMS=-Xms1024m
 ENV JAVA_XMX=-Xmx1024m

README.md

@@ -1,54 +1,56 @@
-# REST starter App with Java Spring-Boot, Gradle, MongoDB, Webflux
-This is a simple Java Reactive Spring boot starter app with MondoDB and Web Flux. This starter app have minimal code taking advantage of the spring framework and the insanely cool reactive dependencies !!!
+# RESTful API server app with Java Spring Reactive Framework
+A light-weight RESTful API server starter app built with Java Spring Reactive Framework, MongoDB, WebFlux and Gradle. 
 
 ### Running the App with Docker
 Use the below to run mongoDB and the app on docker containers.
 ```
+./gradlew clean build  
 docker-compose up
 ```
 
 ### Running the App without Docker
 For this you will need to set up the MongoDB Locally on your machine(Refer the Local MongoDB Setup section towards the end.). 
 Add the configurations in ```application.properties```  
 ```
+./gradlew clean build
 ./gradlew bootRun
 ```
 
-### CRUD - Use cURL to access / test the REST APIs.
+### Try the CRUD - Use cURL to access / test the APIs.
 Once the server is running try the following APIs: 
 
 
-GET /contacts/get
+GET /api/get
 ```
-curl http://localhost:8083/contacts/get
+curl http://localhost:4000/api/get
 ```
 
-GET /contacts/get/{email}
+GET /api/get/{email}
 
 ```
-curl http://localhost:8083/contacts/get/{email}
+curl http://localhost:4000/api/get/{email}
 ```
 
-POST /contacts/add
+POST /api/add
 
 ```
-curl -X POST -d '{"name":"Giri Jeedigunta","email":"giri@yopmail.com"}' -H "Content-Type: application/json" http://localhost:8083/contacts/add -v
+curl -X POST -d '{"name":"Giri Jeedigunta","email":"giri@yopmail.com"}' -H "Content-Type: application/json" http://localhost:4000/api/add -v
 ```
 
-POST /contacts/udpate/{id}
+POST /api/udpate/{id}
 
 ```
-curl -X POST -d '{"name":"Giri J","email":"giri@giri.com"}' -H "Content-Type: application/json" http://localhost:8083/contacts/update/5f85c2c8b0abe7062019dd16
+curl -X POST -d '{"name":"Giri J","email":"giri@giri.com"}' -H "Content-Type: application/json" http://localhost:4000/api/update/5f85c2c8b0abe7062019dd16
 ```
 
-POST /contacts/delete/{id}
+POST /api/delete/{id}
 
 ```
-curl -X POST http://localhost:8083/contacts/delete/5f85c2c8b0abe7062019dd16
+curl -X POST http://localhost:4000/api/delete/5f85c2c8b0abe7062019dd16
 ```
 
 ### Local MongoDB Setup(Mac OS):
-Use these steps if you are not familiar with docker.
+If you are not familiar with docker. Follow these steps to setup MongoDB on your machine locally. Here I have instructions for Mac OS. 
 
 #### Easy MongoDB Installation: 
 ```
@@ -74,16 +76,16 @@ db.createUser({
     user: "giri",
     pwd: "spring2020",
     roles:[
-        {role: "dbAdmin", db:"springContacts"}
+        {role: "dbAdmin", db:"springapi"}
     ]
 });
 ```
 
 ##### Creating New Collection: 
 ```
-use springContacts;
+use springapi;
 
-db.createCollection( "contacts", {
+db.createCollection( "api", {
    validator: { $jsonSchema: {
       bsonType: "object",
       required: [ "name" ],
@@ -103,15 +105,15 @@ db.createCollection( "contacts", {
 
 #####: Sample Data
 ```
-db.contacts.insert({"name":"Giri Jeedigunta","email":"hello@spring.com"});
+db.api.insert({"name":"Giri Jeedigunta","email":"hello@spring.com"});
 ```
 
 #### Adding Configuration to Java App: 
-Add all the MongoDB related config in the following format to ```application.properties```
+Add all the MongoDB related config in a simple URI format like below in the ```application.properties``` file. 
 
 ```
 spring.data.mongodb.uri=mongodb://<Add_Your_UserName>:<Your_Password>@localhost:27017/<DB_NAME>?authSource=admin
 
 // Example: 
-spring.data.mongodb.uri=mongodb://giri:spring2020@localhost:27017/springContacts?authSource=admin
+spring.data.mongodb.uri=mongodb://giri:spring2020@localhost:27017/springapi?authSource=admin
 ```

docker-compose.yml

@@ -1,3 +1,6 @@
+# Author: Giri Jeedigunta
+# Git: https://github.com/giri-jeedigunta/java-spring-mongo-starter-reactive
+
 version: '3.7'
 
 services:

settings.gradle

@@ -1 +1 @@
-rootProject.name = 'ReactiveRESTStarterApp'
+rootProject.name = 'ReactiveRESTfulStarterApp'

src/main/java/com/restful/services/reactiveMongoStarter/repositories/ContactsRepository.java

@@ -1,8 +1,7 @@
-package com.restful.services.reactiveMongoStarter;
+package com.restful.services.springReactiveRESTApp;
 
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
-import org.springframework.context.ApplicationContext;
 import org.springframework.data.mongodb.repository.config.EnableReactiveMongoRepositories;
 /*
 	Author: Giri Jeedigunta
@@ -11,8 +10,8 @@
 
 @SpringBootApplication
 @EnableReactiveMongoRepositories
-public class ReactiveRESTStarterApp {
+public class Application {
 	public static void main(String[] args) {
-		SpringApplication.run(ReactiveRESTStarterApp.class, args);
+		SpringApplication.run(Application.class, args);
 	}
 }

src/main/java/com/restful/services/reactiveMongoStarter/ReactiveRESTStarterApp.java renamed to src/main/java/com/restful/services/springReactiveRESTApp/Application.java

@@ -1,7 +1,7 @@
-package com.restful.services.reactiveMongoStarter.controller;
+package com.restful.services.springReactiveRESTApp.controller;
 
-import com.restful.services.reactiveMongoStarter.model.Contacts;
-import com.restful.services.reactiveMongoStarter.repositories.ContactsRepository;
+import com.restful.services.springReactiveRESTApp.model.Apis;
+import com.restful.services.springReactiveRESTApp.repositories.ApisRepository;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.*;
@@ -10,44 +10,44 @@
 
 @RestController
 @Slf4j
-@RequestMapping("/contacts")
-public class ContactsAPIController {
+@RequestMapping("/api")
+public class RestAPIsController {
 
     @Autowired
-    private ContactsRepository contactsRepo;
+    private ApisRepository apiRepo;
 
     /* Sends All the data availabe in the collection. */
     @GetMapping("/get")
-    public Flux<Contacts> index() {
-        return contactsRepo.findAll();
+    public Flux<Apis> index() {
+        return apiRepo.findAll();
     }
 
     /* Sends the data matching the email. */
     @GetMapping("/get/{email}")
-    public Mono<Contacts> getContactByEmail(@PathVariable("email") String email) {
-        return contactsRepo.findByEmail(email);
+    public Mono<Apis> getContactByEmail(@PathVariable("email") String email) {
+        return apiRepo.findByEmail(email);
     }
 
     /* Add new contact */
     @PostMapping(path = "/add", consumes = "application/json")
-    public Mono<Contacts> addNewContact(@RequestBody Contacts contact) {
-        return contactsRepo.save(contact);
+    public Mono<Apis> addNewContact(@RequestBody Apis contact) {
+        return apiRepo.save(contact);
     }
 
     /* Update existing contact */
     @PostMapping(path = "/update/{id}", consumes = "application/json")
-    public Mono<Contacts> updateContactById(@PathVariable("id") String id, @RequestBody Contacts contact) {
-        return contactsRepo.findById(id)
+    public Mono<Apis> updateContactById(@PathVariable("id") String id, @RequestBody Apis contact) {
+        return apiRepo.findById(id)
                 .flatMap(existingContact -> {
                     existingContact.setName(contact.getName());
                     existingContact.setEmail(contact.getEmail());
-                    return contactsRepo.save(existingContact);
+                    return apiRepo.save(existingContact);
                 });
     }
 
     /* Delete existing contact */
     @PostMapping(path = "/delete/{id}")
     public Mono<String> deleteContactById(@PathVariable("id") String id) {
-        return contactsRepo.deleteById(id).thenReturn("Successfully deleted -> "+id);
+        return apiRepo.deleteById(id).thenReturn("Successfully deleted -> "+id);
     }
 }

src/main/java/com/restful/services/reactiveMongoStarter/controller/ContactsAPIController.java renamed to src/main/java/com/restful/services/springReactiveRESTApp/controller/RestAPIsController.java

@@ -1,15 +1,12 @@
-package com.restful.services.reactiveMongoStarter.model;
+package com.restful.services.springReactiveRESTApp.model;
 
-import lombok.AllArgsConstructor;
 import lombok.Data;
-import lombok.NoArgsConstructor;
-import lombok.ToString;
 import org.springframework.data.annotation.Id;
 import org.springframework.data.mongodb.core.mapping.Document;
 
 @Document
 @Data
-public class Contacts {
+public class Apis {
     @Id
     private String id;
 

src/main/java/com/restful/services/reactiveMongoStarter/model/Contacts.java renamed to src/main/java/com/restful/services/springReactiveRESTApp/model/Apis.java

@@ -0,0 +1,11 @@
+package com.restful.services.springReactiveRESTApp.repositories;
+
+import com.restful.services.springReactiveRESTApp.model.Apis;
+import org.springframework.data.mongodb.repository.ReactiveMongoRepository;
+import org.springframework.stereotype.Repository;
+import reactor.core.publisher.Mono;
+
+@Repository
+public interface ApisRepository extends ReactiveMongoRepository<Apis, String> {
+    Mono<Apis> findByEmail(String email);
+}