webdev-demo-rest_notes

Overview

This is a basic back-end application with a RESTful JSON interface. The application manages note entities with the following JSON model:

{
   id: <unique integer>,
   body: <text body>
}

The back-end interfaces with unix curl to accept/exectute the following RESTful commands:

• GET
• GET/{id}
• POST
• PUT/{id}
• DELETE
• DELETE/{id}

Examples from Linux prompt:

% curl -i -H "Content-Type: application/json" -X GET http://localhost:8080/Note/api/notes
% curl -i -H "Content-Type: application/json" -X POST -d '{"body" : "Pick up biscuits."}' http://localhost:8080/Note/api/notes
% curl -i -H "Content-Type: application/json" -X PUT -d '{"body" : "Mow the lawn."}' http://localhost:8080/Note/api/notes/10
% curl -i -H "Content-Type: application/json" -X DELETE http://localhost:8080/Note/api/notes/3

In addtion to the unix command line prompt this project includes a web front end. The web front end displays a table of all the notes along with their unique IDs. A simple text box input provides the user the ability to add a new note.

Users can delete or modify single notes from within each table row.

Technologies

This project demonstrates the following technologies

• RESTful JSON API using java & jersey
• Front end interface to RESTful service using HTML/CSS/JS
  • Bootstrap styling
  • Google fonts
  • Responsive web page sizing with Bootstrap components
• Interaction with backend web app via jQuery & AJAX.
• Maven build and dependency management
  • Deployment and undeployment to Apache Tomacat via Maven

Items left to do:

• improve error handling
• JUNIT validation
• write better installation instructions

Installation

To build & deploy to Tomcat: mvn tomcat7:undeploy clean package tomcat7:deploy

This application is run as a WAR deployed on Apached Tomcat.

Running the application

The default landing page for the application is http://localhost:8080/Notes.

Validation

Validation was done using Postman & curl.

IDE

The java portion of this project was developed in NetBeans. The Web portion was developed using VS Code.

The operating system is Ubuntu 16.04 LTS.

No testing was done on Windows based machines or alternate browsers.