Flux Bank API

A modern, high-performance Bank Management API built with .NET 10. This project demonstrates a clean architecture approach by separating the web interface from the data persistence layer using Entity Framework Core.

🏗 Project Structure

The solution is divided into two main projects to ensure a clean separation of concerns and maintainability.

1. `Flux.Api` (Web Layer)

Role: Handles HTTP requests, routing, and API documentation.
Key Components:
- Controllers/: Contains BankController.cs which manages CRUD logic.
- Program.cs: Configures dependency injection, middleware pipeline, and OpenAPI (Scalar).
Dependencies: Microsoft.AspNetCore.OpenApi, Scalar.AspNetCore, Flux.Data.

2. `Flux.Data` (Data Layer)

Role: Manages the database schema, data models, and persistence.
Key Components:
- Models/: Contains the BankAccount.cs domain model.
- BankDbContext.cs: The Entity Framework context used to interact with the SQLite database.
Dependencies: Microsoft.EntityFrameworkCore.Sqlite.

🚀 Getting Started

Prerequisites

.NET 10 SDK
A terminal (bash, zsh, or PowerShell)

Installation & Setup

Clone the repository

git clone [https://github.com/adamtlee/Flux.git](https://github.com/adamtlee/Flux.git)
cd Flux

Restore Dependencies
```
dotnet restore
```
Run the API Navigate to the API project folder and start the server:
```
cd src/Flux.Api
dotnet run
```
The API will typically start at http://localhost:5271.

📖 API Documentation

This project uses Scalar for modern, interactive API documentation. Once the application is running, you can explore and test the endpoints visually:

Interactive UI: http://localhost:5271/scalar/v1
Raw OpenAPI JSON: http://localhost:5271/openapi/v1.json

🛠 API Endpoints

All /api/bankaccounts endpoints require Authorization: Bearer <token>.

Auth (`/api/auth`)

Method	Endpoint	Description
POST	`/api/auth/register`	Register a new user and return JWT token response
POST	`/api/auth/login`	Authenticate an existing user and return JWT token response

Bank Accounts (`/api/bankaccounts`)

Method	Endpoint	Description
GET	`/api/bankaccounts`	Retrieve all bank accounts
GET	`/api/bankaccounts/{id}`	Retrieve a specific account by GUID
POST	`/api/bankaccounts`	Create a new bank account
PUT	`/api/bankaccounts/{id}`	Update an existing bank account
DELETE	`/api/bankaccounts/{id}`	Delete a bank account

Example Create Account Request (cURL)

curl -X POST http://localhost:5271/api/bankaccounts \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
    "owner": "Adam Lee",
    "balance": 1000.00,
    "type": "Checking"
}'

📦 Database

This project uses SQLite for data persistence. The database file (flux_bank.db) is automatically created when you first run the application. Data is persisted across application restarts.

🔐 JWT Auth (Local API)

The API is secured with Microsoft.AspNetCore.Authentication.JwtBearer.

# Set credentials in env vars (no hardcoded secrets in commands)
export API_USERNAME="${API_USERNAME:?set API_USERNAME}"
export API_PASSWORD="${API_PASSWORD:?set API_PASSWORD}"

# 1) Register a user
curl -s -X POST http://localhost:5271/api/auth/register \
    -H 'Content-Type: application/json' \
    -d "{\"username\":\"$API_USERNAME\",\"password\":\"$API_PASSWORD\"}"

# 2) Login and extract token (macOS/Linux zsh/bash)
TOKEN=$(curl -s -X POST http://localhost:5271/api/auth/login \
    -H 'Content-Type: application/json' \
    -d "{\"username\":\"$API_USERNAME\",\"password\":\"$API_PASSWORD\"}" \
    | sed -n 's/.*"accessToken":"\([^"]*\)".*/\1/p')

echo "TOKEN length: ${#TOKEN}"

# 3) Call protected endpoint
curl -s http://localhost:5271/api/bankaccounts \
    -H "Authorization: Bearer $TOKEN"

# Optional: verify unauthorized request returns 401
curl -s -o /dev/null -w "%{http_code}" http://localhost:5271/api/bankaccounts

FilesExpand file tree

Readme.md

Latest commit

History