dvdscripter / go-bank-transfer

Simple API for banking routines using a Clean Architecture in Golang. :credit_card: :moneybag: :money_with_wings:

Welcome to Go Bank Transfer 🏦

• Go Bank Transfer is a simple API for some banking routines, such as creating accounts, listing accounts, listing balance for a specific account, transfers between accounts and listing transfers.

Architecture

• This is an attempt to implement a clean architecture, in case you don’t know it yet, here’s a reference https://blog.cleancoder.com/uncle-bob/2012/08/13/the-clean-architecture.html

Requirements/dependencies

• Golang (not obligatory)
• Docker
• Docker-compose

Getting Started

• Environment variables

make init

• Starting API

make up

• Run tests in container (it is necessary to have the application started)

make test-container

• Run tests local (it is necessary to have golang installed)

make test

• View logs

make logs

• Enter in container

make enter-container

API Request

Endpoint	HTTP Method	Description
/api/accounts	POST	Create accounts
/api/accounts	GET	List accounts
/api/accounts/{{account_id}}/balance	GET	Find balance account
/api/transfers	POST	Create transfer
/api/transfers	GET	List transfers

Test endpoints API using Postman

Test endpoints API using curl

• Creating new account

curl -i --request POST 'http://localhost:3001/api/accounts' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Test",
    "cpf": "070.910.584-24",
    "balance": 1.00
}'

• Listing accounts

curl -i --request GET 'http://localhost:3001/api/accounts'

• Fetching account balance

curl -i --request GET 'http://localhost:3001/api/accounts/{{account_id}}/balance'

• Creating new transfer

curl -i --request POST 'http://localhost:3001/api/transfers' \
--header 'Content-Type: application/json' \
--data-raw '{
	"account_destination_id": "{{account_id}}",
	"account_origin_id": "{{account_id}}",
	"amount": 1.00
}'

• Listing transfers

curl -i --request GET 'http://localhost:3001/api/transfers'

Git workflow

• Gitflow

Code status

• Development

Author

• Gabriel Sabadini Facina - GSabadini

License

Copyright © 2020 GSabadini.
This project is MIT licensed.