Commitizen friendly

Bank Microservice

This microservice provides banking functionalities through a clean architecture approach, utilizing Domain-Driven Design (DDD) principles, built using the latest version of .NET Core i.e. .NET 8.0

Features

  • Create a new bank account
  • Retrieve an existing bank account
  • Activate an existing bank account
  • Deactivate an existing bank account

Technologies Used

dotnet docker seq

Solution Structure 

📂 bank/
│
├── src/
│   ├── Payment.Bank.Api/
│   │   ├── Controllers/
│   │   ├── Extensions/
│   │   ├── Middlewares/
│   │   ├── Options/
│   │   ├── Swagger/
│   │   ├── Program.cs
│   │   ├── appsettings.json
│   │   └── Startup.cs
│   │
│   ├── Payment.Bank.Application/
│   │   └── Accounts/
│   │       ├── Features/
│   │       │   ├── ActivateAccount/
│   │       │   ├── CreateAccount/
│   │       │   ├── DeactivateAccount/
│   │       │   └── GetAccount/
│   │       ├── Repositories/
│   │       └── Services/
│   │
│   ├── Payment.Bank.Common/
│   │   ├── Abstractions/
│   │   ├── Exceptions/
│   │   ├── Extensions/
│   │   ├── Mappers/
│   │   └── Utilities/
│   │
│   ├── Payment.Bank.Domain/
│   │   ├── Entities/
│   │   ├── Exceptions/
│   │   └── ValueObjects/
│   │
│   └── Payment.Bank.Infrastructure/
│       └── Repositories/
│
├── README.md
├── LICENSE
└── .gitignore

Getting Started

Prerequisites

  • .NET Core SDK 8.0
  • Docker installed on your machine.

Installation

Clone the repository:

git clone https://github.com/salzaki/bank.git

Navigate to the project directory:

cd bank

Makefile Reference 

  build-docs                    🔨 Builds docs on local machine
  check-certs                   🔍 Checks development certs
  check                         🔍 Checks installed dependencies on local machine
  clean-certs                   🤖 Cleans up development certs
  clean-docs                    🧹 Cleans docs site
  clean                         🧹 Cleans up project
  docker-build                  🏃 Builds container using Docker compose
  docker-lint                   🐳 Lints Dockerfile
  docker-start                  🏃 Stars container using Docker compose
  docker-stop                   🏃 Stops container using Docker compose
  help                          💬 This help message
  install-certs                 🔐 Installs development certs
  install-docs                  🛠️ Installs necessary dependencies to build docs in Ruby
  lint-fix                      🔧 Lints & formats, fixes errors and modifies code
  lint                          🔎 Checks for linting and formatting errors in code
  run-docs                      🤖 Runs project docs (this listens for changes)
  serve-docs                    🏃️ Runs project docs (this does not listen for changes)

Quick Start

Build the project using make, from the root of the project run:

make check-certs # run this to check is dev certs are installed
make install-certs # install dev certs
make docker-start

Open https://localhost:5001

Config Certificate

You can also configure certs manually by running the following commands to Configure SSL in your system:

Windows using Linux containers 

dotnet dev-certs https -ep %USERPROFILE%\.aspnet\https\aspnetapp.pfx -p password
dotnet dev-certs https --trust

Note: for running this command in powershell use $env:USERPROFILE instead of %USERPROFILE%

macOS or Linux 

dotnet dev-certs https -ep ${HOME}/.aspnet/https/aspnetapp.pfx -p $CREDENTIAL_PLACEHOLDER$
dotnet dev-certs https --trust

Docker

AppSettings

Api Settings 

"Api": {
  "Name": "Bank-Api",
  "Version": "1.0",
  "ApiVersionHeader": "x-api-version",
  "ReportApiVersions": true,
  "BaseUrl": "/api",
  "DocumentationUrl": "api/v1/documentation/",
  "BannerEnabled": true,
  "Authorization": {
    "ApiKey": "607F6A23-D130-46CD-A93C-6D9A6E5A8FB2"
  }
}

Swagger Settings 

"Swagger": {
  "Enabled": true,
  "Name": "Bank-Api",
  "RoutePrefix": "api-docs",
  "RouteTemplate": "/api-docs/swagger/{documentName}/swagger.json",
  "EndpointPath": "/api-docs/swagger/{0}/swagger.json",
  "Info": {
    "Title": "Bank Api documentation",
    "Description": "Provides documentation for Bank Api.",
    "License": {
      "Name": "MIT License",
      "Url": "https://en.wikipedia.org/wiki/MIT_License"
    },
    "Contact": {
      "Name": "Sal Zaki",
      "Email": "salzaki@hotmail.com"
    }
  }
}

Feature Management Settings 

"FeatureManagement": {
  "CreateAccount": true,
  "GetAccount": true,
  "DeactivateAccount": true,
  "ActivateAccount": true
}

Account Controller with Feature Gate 

[HttpGet("{accountNumber:int}", Name = "GetByAccountNumber")]
[FeatureGate(Constants.Features.GetAccount)]
[SwaggerOperation(
    OperationId = nameof(GetByAccountNumberAsync),
    Description = "Gets an account by account number.",
    Tags = ["Account"])]
[SwaggerResponse(StatusCodes.Status200OK, Type = typeof(GetAccountResponse))]
[SwaggerResponse(StatusCodes.Status400BadRequest, Type = typeof(BadRequest<ProblemDetails>))]
[SwaggerResponse(StatusCodes.Status404NotFound, Type = typeof(NotFound))]
[SwaggerResponse(StatusCodes.Status500InternalServerError, Type = typeof(ProblemDetails))]
public async Task<Results<Ok<GetAccountResponse>, BadRequest<ProblemDetails>, NotFound>> GetByAccountNumberAsync(
  [FromServices] IAccountService accountService,
  [Required][FromRoute] int accountNumber,
  CancellationToken cancellationToken = default)
{
  ...
}

Business Policies - Not implemented Yet 

public void Deposit(decimal amount)
{
  this.CheckPolicy(DepositCannotBeMadeToDeactivatedAccountPolicy);
  this.AccountBalance += amount;
}

Api Documentation

Structured Logging

Seq

Seq

Roadmap

List of features/tasks/approaches to add:

Name Status Release date
Domain Unit Tests To do TBA
Application Unit Tests To do TBA
Integration Automated Tests To do TBA

Resources and References

Seq

Domain-Driven Design

Application Architecture

License

Fun Quote

As you start to walk on the way, the way appears.

Rumi