REST demo: Java backend

A simple demonstration of a RESTful web service in Java.

This repository implements a REST web service for managing a simple database of bookmarks. Each bookmark consists of a name (the link text) and the URL that it should link to. Using this API, you can perform all of the standard "CRUD" operations (Create, Read, Update, Delete) on these bookmarks.

This repository is part of my REST API demonstration project. For more information on this project, including a list of all available frontends and backends, please visit the following repo:

• rest-demo

Installation and Deployment

There are configuration files in this repository to support installing and deploying this code through three different methods. Following the instructions for any one of these methods should setup a local running instance of this API application.

Method 1: Using Docker & docker-compose (preferred)

The easiest way to try out the code in this repository is via the docker-compose method described in the README for the main rest-demo project:

• README.md: Method 1: Using Docker & docker-compose (preferred)

To request this backend specifically, make sure your docker-compose command is prefixed with BACKEND=java, like so:

> BACKEND=java docker-compose up -d --build

For more details, please see the "Method 1" section in the README link above.

Method 2: Using Docker without docker-compose

Requirements:

• git - version 1.7.10 or later recommended
• Docker - version 17.05 or later

This method will build a Docker image for this application, and then create and run a container instance based on it.

Run the following commands to use this method:

> docker build -t bookmarkapi:deploy https://github.com/bmarcotte/rest-demo-java-backend.git
> docker run --name bookmarkapi -p 8080:8080 -d bookmarkapi:deploy

Method 3: Using JDK, Maven, Tomcat

Requirements:

• git - version 1.7.10 or later recommended
• Java JDK - version 8u151 or later (either OpenJDK or Oracle JDK)
  • The JAVA_HOME environment variable will need to be set to the root of where your Java JDK is installed, and not to the "jre/" subdir that's inside of it.
• Maven - version 2.0.0 or later
• Tomcat - version 8.5.27 or later
  • The CATALINA_HOME environment variable should be set to the path where your Tomcat instance is installed, e.g. /usr/local/tomcat, /opt/tomcat, etc.

If Docker is not available, you can try manually building and installing the application via this method.

Run the following commands to use this method:

git clone https://github.com/bmarcotte/rest-demo-java-backend.git
cd rest-demo-java-backend
mvn clean install
cp target/ROOT.war ${CATALINA_HOME}/webapps/

Testing

Requirements:

• Maven - version 2.0.0 or later

This repository includes a simple JUnit test suite that can be invoked with the following command:

mvn test

For details on how to do more extensive functional endpoint testing of this backend web service, please see the following documentation in my rest-demo project repository:

• TESTING.md

Author

• Ben Marcotte - bmarcotte

License

This project is licensed under the MIT License - see the LICENSE file for details