https://github.com/kpavlov/ak3-bank

Akka-Kotlin-Koin-Ktor (AK^3) Bank API
https://github.com/kpavlov/ak3-bank

akka akka-actors koin kotlin-language ktor ktor-framework microservice oas3 rest-api

Last synced: 25 days ago
JSON representation

Akka-Kotlin-Koin-Ktor (AK^3) Bank API

• Host: GitHub
• URL: https://github.com/kpavlov/ak3-bank
• Owner: kpavlov
• License: gpl-3.0
• Created: 2018-06-26T15:12:17.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-10-02T10:41:41.000Z (about 1 month ago)
• Last Synced: 2024-10-03T10:47:43.678Z (about 1 month ago)
• Topics: akka, akka-actors, koin, kotlin-language, ktor, ktor-framework, microservice, oas3, rest-api
• Language: Kotlin
• Size: 93.8 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# AK3 Bank API

## Akka-Kotlin-Koin-Ktor (AK3) Bank API

[![Build Status](https://travis-ci.org/kpavlov/ak3-bank.svg?branch=master)](https://travis-ci.org/kpavlov/ak3-bank)

[![codecov](https://codecov.io/gh/kpavlov/ak3-bank/branch/master/graph/badge.svg)](https://codecov.io/gh/kpavlov/ak3-bank)

The project consists of an API to be used for opening customer bank accounts and saving transactions.

The API will expose an endpoint which accepts the user information (`customerID`, `initialCredit`).

Once the endpoint is called, a new account will be opened connected to the user whose ID is `customerID`.

Also, if `initialCredit` is not 0, a transaction will be sent to the new account.

Another Endpoint will output the user information showing _Name_, _Surname_, _balance_, and transactions of the accounts.

## Assumptions

* For simplicity, the data is saved in memory and not actually persisted, so that the solution could be easier tested.

* All accounts are opened in the same currency (which is not always a case in real life)

* Application security is skipped: no Authentication, Authorization and TLS. Full logging is enabled.

* There are no restriction for the customer to open new account. 

    The restriction could be maxActiveAccounts or max deposit amount. Now it's omitted.

## Implementation notes

* [Swagger codegen](https://github.com/swagger-api/swagger-codegen) 

  is not mature enough to generate server interfaces for Ktor server. 

  That's why only DTO classes are generated.

## Build instructions

To build with maven and start:

    ./build-and-start.sh

    

## REST API Commands

### Create Customer

    curl -v \

        -H "Content-Type: application/json" \

        -H "Accept: application/json" \

        --data '{"firstName": "Tirion", "lastName": "Lannister"}' \

        http://localhost:8080/v1/customers | jq

### Create new current account with balance

    curl -v \

        -H "Content-Type: application/json" \

        -H "Accept: application/json" \

        --data '{"initialCredit": 100500.42, "type": "CURRENT"}' \

        http://localhost:8080/v1/customers/1/accounts | jq 

        

### Get customer info with account statements

    curl -v \

        -H "Accept: application/json" \

        http://localhost:8080/v1/customers/1 | jq