Spring makes programming Java quicker, easier, and safer for everybody. Spring’s focus on speed, simplicity, and productivity has made it the world's most popular Java framework.

---

Table of Contents

• Introduction
• Installation
• Running the Application
• Testing
• Documentation
• Environment Configuration
• Support
• Stay in Touch
• License

---

Introduction

Dragons API is a Java project built with the Spring Boot framework. It serves as an example of an API repository, demonstrating best practices in API development using modern Java technologies.

Installation

To get started with Dragons API, follow these steps:

# clone this repository:
git clone https://github.com/bolicos/dragons-api.git

# navigate into the project directory:
cd dragons-api

# build the project and install dependencies using Gradle:
./gradlew build

Running the application

You can run the Dragons API in different modes:

# development mode
./gradlew bootRun

# docker mode
docker build -t image_name/app_name:latest .

# production mode
./gradlew bootRun

Testing

Dragons API comes with comprehensive test coverage. Use the following commands to run tests:

# run unit tests:
./gradlew test

# run end-to-end (e2e) tests:
./gradlew test:e2e

# check test coverage:
./gradlew test:coverage

Documentation

API documentation is available through Swagger OpenAPI. Access it by clicking here to explore the available endpoints.

Environment Configuration

An example of the .properties file is provided within the project to help you configure your environment.

Support

Top-tier support for Spring, Apache Tomcat®, and Java OpenJDK™, along with exclusive enterprise-ready features, components and extensions. It's available as part of VMware Tanzu Platform.

Stay in touch

• Author - Bolicos
• Website - Linktree
• Linkedin - Perfil

License

Dragons API is licensed under the MIT licensed.