This is a RESTFul web service with endpoints to handle requests for managing drones used for transporting medications.
The following installation(s) is(are) needed on your local environment to run the service.
These instructions will get the service up & running on your local environment.
- For Docker Prerequisite Satisfied:
- Open terminal in project's root directory i.e where the file named
Dockerfile
is located. - Run command
docker build -t drone-web-service .
to build the docker image. - Run command
docker run -p 8080:8080 -d drone-web-service
to spin up a container for the created image. - Services are now available at
http://localhost:8080/...
. View documentation for available endpoints.
- For Java 8 & Maven Prerequisite Satisfied:
- Open terminal in project's root directory.
- Run command
mvn clean install
to install dependencies, build and package. - Rum command
java -Dspring.profiles.active=default -jar ./target/drone-web-service.jar
- Services are now available at
http://localhost:8080/...
. View documentation for available endpoints.
View api documentation at
- Postman documentation located at Drone-Web-Service.postman_collection.json
- Postman documentation published at https://documenter.getpostman.com/view/9270015/UVeCPTHk
- Swagger documentation at http://localhost:8080/swagger-ui.html (while the service is running)
View H2 in-memory database at http://localhost:8080/h2-console login details specified at application.properties (while the service is running)