OakPeak.Core

Description

OakPeak.Core is a powerful framework for building enterprise-grade microservices and web applications in .NET. It provides a comprehensive set of APIs, tools, and utilities to streamline your development process and enhance productivity.

Features

• Multi-version Support: Compatible with .NET 5, .NET 6, .NET 8 and .NET 9
• Authentication & Security: JWT, Basic Auth, API Key, and external providers (Microsoft, Google, Facebook)
• Multi-tenancy: Built-in support for multi-tenant applications
• Background Processing: Robust scheduler with cron-based task scheduling
• Data Access: Repository pattern implementation with SQL helpers
• Notification System: Email and cloud notification services
• Logging & Monitoring: Structured logging with Serilog integration
• API Documentation: Swagger/OpenAPI integration
• Health Checks: Built-in health monitoring endpoints

Installation

NuGet Package

Install the package using NuGet Package Manager or by executing the following command in the Package Manager Console:

Install-Package OakPeak.Core

For specific .NET versions:

# For .NET 6 Install-Package OakPeak.Core -Version 6.0.2 # For .NET 8 Install-Package OakPeak.Core -Version 8.0.6 # For .NET 9 Install-Package OakPeak.Core -Version 9.0.1

System Architecture

OakPeak.Core follows a multi-layered architecture:

Core Components

• Controllers: Handle API endpoints and request processing
• Services: Implement business logic and application workflows
• Repositories: Manage data access and persistence
• Entities: Represent domain objects and data models

Middleware Pipeline

OakPeak.Core includes several middleware components for cross-cutting concerns:

• AppContextMiddleware: Manages application context for each request
• ApiKeyMiddleware: Handles API key authentication
• BasicAuthenticationMiddleware: Processes HTTP Basic authentication
• ErrorHandlingMiddleware: Provides centralized error handling
• DomainErrorHandlerMiddleware: Handles domain-specific errors

Authentication and Security

Multiple authentication methods are supported:

• JWT Token Authentication: For secure API access
• Basic Authentication: For simple username/password authentication
• API Key Authentication: For service-to-service communication
• External Providers: Microsoft, Google, Facebook integration

Multi-tenancy Support

The framework includes built-in multi-tenancy capabilities:

• Tenant identification based on host, query string, or custom logic
• Tenant-specific configuration and settings
• Tenant isolation for data and resources

Setup and Configuration

Basic Setup

Add OakPeak.Core to your ASP.NET Core application in Program.cs or Startup.cs:

// Add services services.AddOakPeakCore(Configuration); // Configure middleware app.UseOakPeak();

Configuration Files

Configure OakPeak.Core in your appsettings.json:

{ "ConnectionStrings": { "DefaultConnection": "Server=...;Database=...;User Id=...;Password=...;" }, "AppSettings": { "EnableSwagger": true, "HealthBaseUrl": "https://your-api-base-url.com" }, "JwtIssuerOptions": { "Issuer": "your-issuer", "Audience": "your-audience", "Subject": "your-subject", "ValidFor": "24:00:00", "Key": "your-secret-key-with-at-least-16-characters" }, "EmailConfiguration": { "Provider": "smtp", "SmtpServer": "smtp.example.com", "SmtpPort": 587, "SmtpUsername": "user@example.com", "SmtpPassword": "password", "FromEmail": "noreply@example.com", "UseSsl": true, "Title": "Your Application Name", "TemplateFile": "email-template.html" } }

Key Components

Authentication

Configure authentication in your application:

services.AddAuthentication(options => { options.JwtIssuerOptions = new JwtIssuerOptions { Issuer = Configuration["JwtIssuerOptions:Issuer"], Audience = Configuration["JwtIssuerOptions:Audience"], Subject = Configuration["JwtIssuerOptions:Subject"], ValidFor = Configuration.GetValue<TimeSpan>("JwtIssuerOptions:ValidFor"), Key = Configuration["JwtIssuerOptions:Key"], }; });

Scheduler

Create scheduled tasks by implementing the IScheduledTask interface:

public class MyScheduledTask : BaseSchedulerTask { public override string Schedule => "0 */12 * * *"; // Cron expression public override async Task DoWork() { // Task implementation await Task.CompletedTask; } }

Register scheduled tasks:

services.AddScheduler((sender, args) => { Console.Write(args.Exception.Message); args.SetObserved(); }); services.AddSingleton<IScheduledTask, MyScheduledTask>();

Notification System

Send emails using the notification service:

public class MyService { private readonly INotificationService _notificationService; public MyService(INotificationService notificationService) { _notificationService = notificationService; } public async Task SendNotification() { await _notificationService.CreateAndSendHtmlEmail( "recipient@example.com", "Recipient Name", "Email Subject", "<p>Email body content</p>" ); } }

Data Access

Use the data provider for database operations:

public class MyRepository { private readonly IDataProvider _dataProvider; public MyRepository(IDataProvider dataProvider) { _dataProvider = dataProvider; } public IEnumerable<MyEntity> GetItems() { return _dataProvider.ExecuteReader("GetItems").FillCollection<MyEntity>(); } }

CI/CD Integration

OakPeak.Core includes Azure DevOps pipeline configurations for different .NET versions:

• azure-pipelines.yml - Main pipeline for .NET 5
• azure-pipelines-NET6.yml - Pipeline for .NET 6
• azure-pipelines-NET8.yml - Pipeline for .NET 8

These pipelines automate the build, test, and deployment processes for your applications.

API Documentation

OakPeak.Core integrates with Swagger/OpenAPI for API documentation. Enable it in your application:

services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new OpenApiInfo { Title = "Your API", Version = "v1" }); c.EnableAnnotations(); }); app.UseSwagger(); app.UseSwaggerUI(c => c.SwaggerEndpoint("/swagger/v1/swagger.json", "Your API v1"));

License

This project is licensed under the MIT License.

Support

For issues, questions, or contributions, please contact us or open an issue on the repository.

Acknowledgements

OakPeak.Core is developed and maintained by Brighten Consulting.

© 2025 Brighten Consulting. All rights reserved.

---

This documentation is subject to change as the framework evolves. Always refer to the latest version for the most up-to-date information.