jjayaraman/animals-api

Animals API - Spring Boot app

Animals API

Animals API is a Spring Boot web application with a Swagger documented API.

Getting Started

Prerequisites

First install:

• Java 17
• Maven 3.6.3+

Commands

Run the service:

mvn spring-boot:run

Tests with coverage:

mvn clean test

Build the .jar:

mvn clean package    

Docker

Note: these are not tested on all environments, if you struggle with them then just run the jar with mvn spring-boot:run

If you are familiar with docker you may wish to use it to run the service.

Run with Docker (build jar first)

docker-compose up

Run from Docker Hub

docker run --rm -p 8080:8080 -d catapultcx/animals-api:latest

Publish to Docker Hub

./docker.sh

URLs

Once started the API will be available at:

• http://localhost:8080

API docs can be found at:

• http://localhost:8080/api-docs
• http://localhost:8080/swagger-ui.html

Reference Documentation

For further reference, please consider the following sections:

• Swagger
• Official Apache Maven documentation
• Spring Boot Maven Plugin Reference Guide
• JaCoCo and maven
• JaCoCo and maven
• Spring Boot guide
• Spring Boot and Docker
• MySql