Damish-N / PetStoreAssignment

PetStoreAssignment

Damish Nisal

18001599

SCS3203 / IS3108 Middleware Architecture

Pet Store

To build and deploy the API

Run the following commands and up the swagger and refer the End points

step 1:

run the command on terminal

./gradlew build -Dquarkus.package.type=uber-jar

step 2

run the command on terminal

java -jar build/petStore-runner.jar

step 3

to find the End-points on here

http://localhost:8080/swagger-ui/

Run Test Suite

run the command on terminal

./gradlew test

CURL/WGET commands

Pets

Get the all the pets

curl -X GET "http://localhost:8080/pets" -H  "accept: application/json"

Create a new pet

curl -X POST "http://localhost:8080/pets" -H  "accept: application/json" -H  "Content-Type: application/json" -d "{\"petAge\":3,\"petName\":\"doggy\",\"petType\":\"dog\"}"

Update an existing pet

curl -X PUT "http://localhost:8080/pets/1" -H  "accept: application/json" -H  "Content-Type: application/json" -d "{\"petAge\":3,\"petName\":\"dikky\",\"petType\":\"dog\"}"

Delete an existing pet

curl -X DELETE "http://localhost:8080/pets/3" -H  "accept: */*"

Search pets with name/type/age

curl -X GET "http://localhost:8080/pets/search?age=5&name=boola&type=dog" -H  "accept: application/json"

Get pet by ID

curl -X GET "http://localhost:8080/pets/3" -H  "accept: application/json"

Pet Types

Get all pet types

curl -X GET "http://localhost:8080/petTypes" -H  "accept: application/json"

Create a new pet type

curl -X POST "http://localhost:8080/petTypes" -H  "accept: application/json" -H  "Content-Type: application/json" -d "{\"petId\":4,\"petType\":\"lion\"}"

Update an existing pet type

curl -X PUT "http://localhost:8080/petTypes/1" -H  "accept: */*" -H  "Content-Type: application/json" -d "{\"petId\":1,\"petType\":\"dogs\"}"

Delete an existing pet type

curl -X DELETE "http://localhost:8080/petTypes/1" -H  "accept: application/json"

Open Swagger

To launch API Doc,Run the project and route with below url

 http://localhost:8080/swagger-ui/

Exposes the information about your endpoints in the format of the OpenAPI v3 specification. Specification here

The index page contains a link to the OpenAPI information of your endpoints.

Schemas

Pet Schema

{
"petAge": int,
"petId": int,
"petName": "string",
"petType": "string" 
}

PetType Schema

{
"petId": int,
"petType": "string"
}

Pet Request Schema

{
"petAge": int,
"petName": "string",
"petType": "string"
}