The rest-api-validation from utsaa

rest-api-validation's Introduction

Table of Contents

Design of the project
Youtube video to explain the code base
How to run the project
End point urls

Design of the project

The design has been explained in following ppt -

https://github.com/greenlearner01/MyNotes/blob/master/ppt/Rest_application_with_spring_boot.pptx

Youtube video to explain the code base

https://www.youtube.com/playlist?list=PLq3uEqRnr_2Hb9M-hz6GPVg_x9TUQ9PJA

How to run the project

Clone it to local - git clone https://github.com/greenlearner01/Microservices.git and
Navigate to userManagementApp folder
Now there are two ways to run the project
- First- running jar file
  - navigate to directory from command prompt
  - execute below command
```
  gradlew clean build 
```
    this will create the jar file inside build/libs
  - go to /build/libs and execute > java -jar .jar
- Sencond way - Directly running the main method
  - Open the project in IntelliJ Idea or eclipse
  - And run the main method inside UserManagementAppApplication.java
The app will run on port 8082

End point urls

AddUser - Post method > http://localhost:8082/user

  Request body - 
  {
    "id": "1234",
    "name": "green learner123",
    "address": "delhi",
    "addresses": [
                   {
                    "line1": "noida", 
                     "line2": "u.p.",
                     "pinCode": "223422"
                   }
                ],
  }

update user - Put method > http://localhost:8082/user

  Request body - 
  {
    "id": "1234",
    "name": "green learner123-updated",
    "address": "delhi-updated",
    "addresses": [
                   {
                    "line1": "noida", 
                     "line2": "u.p.",
                     "pinCode": "223422"
                   }
                ],
  }