rahulkushwah-0 / kaiburr-task1

All the tasks available in this repository

Task 1

🌐 🚀 LIVE APP

NOTE: README First

Requirements

• Java
• Maven
• Spring Boot (Framework)
• MongoDB
• Docker

Dependencies

• spring-boot-starter-web
• spring-boot-starter-data-mongodb
• spring-boot-maven-plugin

Building steps

1. Open the folder /task1 in your favourite IDE ( VS Code ❤️) Wait for few minutes while the IDE loads and completes necessary pre-build tasks.

2. Run mvn clean install This will build and install the artifacts in to the local repository. Required jar file will be created inside /target folder.

3. Run the application by clicking Run option or pressing F9 SpringBoot application server will load and start on port 8080 of the localhost.

Rest API Endpoints and Resources

Rest API Endpoint is mapped to http://127.0.0.1:8080/servers/

• PUT a server http://127.0.0.1:8080/servers/createServer Accept "server" object in body in json format.

• GET servers http://127.0.0.1:8080/servers/getServer Returns a list of "server" objects.

• GET server by ID http://127.0.0.1:8080/servers/getServer?id=<ID> Returns a "server" object matching with ID.

• GET servers by Name http://127.0.0.1:8080/servers/getServer?name=<Nmae> Returns a list of "server" objects matching with Name.

• DELETE server http://127.0.0.1:8080/servers/deleteServer?id=<ID> Deletes a "server" object matching with ID.

RestController interface extends MongoRepository

List<Server> findAll();
    
Optional<Server> findById(String Id);
    
void createOrUpdateServer(Server server);
    
void deleteServerById(String Id);
    
List<Server> findByName(String name);

Containerizing the app

Dockerfile contains all the commands required to build the app image

FROM openjdk:8-alpine EXPOSE 8080 ADD target/demo.jar demo.jar ENTRYPOINT ["java", "-Dspring.data.mongodb.uri=mongodb://mongod:27017/servers", "-jar", "/demo.jar"]

1. Run the following command to build docker image sudo docker build -t <container_image_name> . This will create the app container image and add to you local repository.

2. To Run the app from container, run the following command sudo docker run -p 80:80 <container_image_name> SpringBoot application server will load and start on port 8080 of the localhost You will see application logs in the terminal.

Note: The docker-compose part is Documented in Task3

Consuming APIs

Using Postman

Run the following created collection to Test and consume the APIs

NOTE: The above collection is created and tested for http://127.0.0.1:8080/servers/ endpoint

Screenshots

Using WebUIForms

NOTE: This part is Documented in Task4