Introduction

[ Forked from DropWizard template]

The Dropwizard example application was developed to, as its name implies, provide examples of some of the features present in Dropwizard.

This version has the following customization:

• dropwizard uses port 8088 so that graphite can have 8080
• Postgresql for automated integration tests and production operation (instead of mysql)
• docker-compose that includes graphite and grafana
• Swagger to generate API docs

Overview

Included with this repository is: - Hibernate + Postgres, includes integration testing against Postgres - Grafana and Graphite containers for metrics in dev - Swagger API

Hibernate ORM

The examples provided illustrate a few of the features available in Hibernate, along with demonstrating how these are used from within Dropwizard.

This database example is comprised of the following classes:

• The PersonDAO illustrates using the Data Access Object pattern with assisting of Hibernate.

• The Person illustrates mapping of Java classes to database tables with assisting of JPA annotations.

• All the JPQL statements for use in the PersonDAO are located in the Person class.

• migrations.yml illustrates the usage of dropwizard-migrations which can create your database prior to running your application for the first time.

• The PersonResource and PeopleResource are the REST resource which use the PersonDAO to retrieve data from the database, note the injection of the PersonDAO in their constructors.

As with all the modules the db example is wired up in the initialize function of the HelloWorldApplication.

Running The Application

Install Dependencies

• Java

  Ubuntu Installation:

    sudo apt-get install openjdk-11-jdk
    export JAVA_HOME=/usr/lib/jvm/java-11-openjdk-amd64
    export PATH=$PATH:$JAVA_HOME/bin
  

• Docker & Docker-compose

  Ubuntu Installation:

    sudo apt-get remove docker docker-engine docker.io containerd runc
    sudo apt-get update
    sudo apt-get install \
    	apt-transport-https \
    	ca-certificates \
    	curl \
    	gnupg-agent \
    	software-properties-common
    curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
    sudo add-apt-repository \
    	"deb [arch=amd64] https://download.docker.com/linux/ubuntu \
    	$(lsb_release -cs) \
    	stable"
    sudo apt-get update
    sudo apt-get install docker-ce docker-ce-cli containerd.io docker-compose
  

• Maven

  Ubuntu Installation:

    sudo apt install maven
  

Build

• Build running environment

  The integration tests need the real Postgres db, so get it running

    docker-compose up
  

• Build the app

    mvn clean install -DskipTests
  

• Run tests

    mvn test
  

Run the app!

• To configure the DB

    java -jar target/machete-1.0.0-SNAPSHOT.jar db migrate machete.yml --migrations src/main/resources/migrations.yml 
  

• To run the server run.

    java -jar target/machete-1.0.0-SNAPSHOT server example.yml
  

• To hit the Hello World example (hit refresh a few times).

  http://localhost:8088/hello-world

• To post data into the application.

  curl -H "Content-Type: application/json" -X POST -d '{"fullName":"Other Person","jobTitle":"Other Title"}' http://localhost:8088/people

  open http://localhost:8088/people

• To test the API with swagger

  http://localhost:8088/swagger

Operations

• to check graphite for data

  open http://localhost:8080/

• To check grafana for data

  open http://localhost:3000/ user: admin pw: admin

• To see Swagger spec

  open http://localhost:8088/openapi.json