Basic Transaction REST API

basic-transaction-api-v1

Hi! This is a basic Spring-Boot application where we are exposing a Transaction API

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them

Maven

Optional

* Git
* Code editor: VisualStudio or Eclipse
* Docker

Installing

A step by step series of examples that tell you how to get a development env running

Validate that Maven is correctly configured

mvn -v

Download or clone the project

Download: Click on download link
Clone: git clone https://github.com/gusleyva/basic-transaction-api-v1.git

Open a terminal window (bash/terminal) and move to the project

cd ~/workspace/basic-transaction-api-v1/

Do a maven clean install. Validate that you have an internet connection to download dependencies

mvn clean install

If everything is compiled correctly you will see something similar to:

[INFO] 
[INFO] Results:
[INFO] 
[INFO] Tests run: 4, Failures: 0, Errors: 0, Skipped: 0
[INFO] 
[INFO] 
[INFO] --- maven-jar-plugin:3.1.2:jar (default-jar) @ basic-transaction-api-v1 ---
[INFO] Building jar: /workspace/SpringBoot/basic-transaction-api-v1/target/basic-transaction-api-v1-0.0.1-SNAPSHOT.jar
[INFO] 
[INFO] --- spring-boot-maven-plugin:2.2.2.RELEASE:repackage (repackage) @ basic-transaction-api-v1 ---
[INFO] Replacing main artifact with repackaged archive
[INFO] 
[INFO] --- maven-install-plugin:2.5.2:install (default-install) @ basic-transaction-api-v1 ---
[INFO] Installing /workspace/SpringBoot/basic-transaction-api-v1/target/basic-transaction-api-v1-0.0.1-SNAPSHOT.jar to /.m2/repository/basic-transaction-api-v1/basic-transaction-api-v1/0.0.1-SNAPSHOT/basic-transaction-api-v1-0.0.1-SNAPSHOT.jar
[INFO] Installing /workspace/SpringBoot/basic-transaction-api-v1/pom.xml to /.m2/repository/basic-transaction-api-v1/basic-transaction-api-v1/0.0.1-SNAPSHOT/basic-transaction-api-v1-0.0.1-SNAPSHOT.pom
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  18.186 s
[INFO] Finished at: 2020-03-19T16:50:03-06:00
[INFO] ------------------------------------------------------------------------

There are multiple forms to start the application

1. Spring boot

mvn spring-boot:run

2. Packaging and executing

mvn clean package
java -jar target/basic-transaction-api-v1-0.0.1-SNAPSHOT.jar

3. Docker

docker build -t basic-transaction-api-v1:1.0 .
docker run -d -p 8080:8080 -t basic-transaction-api-v1:1.0

Validate the application is up and running, paste the following url in your browser:

http://localhost:8080/

Validate all end points with api-docs

http://localhost:8090/swagger-ui.html#/

Built With

• Spring-boot - The web framework used
• Maven - Dependency Management
• H2 - In-memory database
• Swagger - Generate API-Docs

Authors

• Gustavo Leyva - Initial work

License

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