Skip to content
HTTP server with REST API for money transfer between bank accounts
Java Shell
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
gradle/wrapper removing Response class Aug 15, 2019
src replacing int with const value for internal server error in Application Aug 16, 2019
.gitignore
.travis.yml
README.md Update README.md Aug 16, 2019
TASK.md fixing formatting Oct 6, 2018
build.gradle updating fat jar name Aug 15, 2019
checkstyle.xml updating formatting of the checkstyle.xml file (removing redundant em… Sep 15, 2018
gradlew
gradlew.bat updating gradle and other stuff Aug 13, 2019
redoc.sh updating docs Aug 14, 2019
sampledata.sh updating docs Aug 14, 2019
settings.gradle creating initial project structre, setting up Gradle build system and… Sep 15, 2018

README.md

money-transfer-api

Build Status codecov

HTTP server with REST API for money transfer between bank accounts

Description of the task can be found in TASK.md file.

Contents

Building and running the application

Please note: If we're on Windows, use gradlew.bat instead of ./gradlew script

  • To build an application, execute: ./gradlew build
  • To start an application on port 8000, execute: ./gradlew run
  • To build an application as a "fat jar", execute: ./gradlew shadowJar
  • To start an application as a "fat jar" on port 8000, execute: java -jar build/libs/app-1.0-SNAPSHOT-all.jar
  • To generate a sample data in the running application, execute: ./gradlew sampleData (if you are Windows user, install curl and run contents from sampledata.sh script manually)

API documentation

  • Start Docker Daemon
  • Pull ReDoc image: sudo docker pull redocly/redoc
  • Start application
  • Run ReDoc: ./gradlew redoc (if you're Windows user, run contents from the redoc.sh script manually)
  • Open website with documentation in the web browser: http://localhost:9000
  • Moreover, API is also documented by tests in RestApiIntegrationTest class

Tests

  • running unit tests: ./gradlew test
  • running integration tests: ./gradlew test -Dtest.profile=integration
  • creating test coverage report: ./gradlew test jacocoTestReport (report will be in build/reports/jacoco/ dir)

Code style

Code style used in the project is called Square from Java Code Styles repository by Square.

You can’t perform that action at this time.