Archetypical.Software.Vega.Api.Abstractions 2.8.0

Archetypical.Software.Vega.Api.Abstractions

archetypical-logo

Base controllers, dependency injection helpers, and common abstractions for building ASP.NET Core APIs, often used with Dapr.

Nuget

Overview

This package provides a set of tools and conventions to accelerate the development of robust, observable, and configurable web APIs. It includes:

• Simplified application setup (CreateVegaApi, UseVegaApiDefaults).
• Base DbContext (VegaDbContext) with multi-provider support.
• Integrated Dapr features (Distributed Cache, Remote Configuration).
• Configuration options (VegaApiOptions) to easily enable/disable features like OData, Swagger, OpenTelemetry, Health Checks, etc.
• Standardized configuration loading from appsettings.json and environment variables.

Installation

Install the package via NuGet:

# .NET CLI
dotnet add package Archetypical.Software.Vega.Api.Abstractions
# Package Manager
Install-Package Archetypical.Software.Vega.Api.Abstractions

You will also likely need packages for the features you intend to use, such as:

• Microsoft.EntityFrameworkCore.SqlServer / Npgsql.EntityFrameworkCore.PostgreSQL / etc. (for DbContext)
• Dapr.AspNetCore (for Dapr integration)
• Swashbuckle.AspNetCore (for Swagger, often included by default)
• OpenTelemetry.Extensions.Hosting / OpenTelemetry.Instrumentation.AspNetCore / etc. (for OpenTelemetry)

Basic Usage (Program.cs)

using Archetypical.Software.Vega.Api.Abstractions;
var builder = VegaApiApplication.CreateVegaApi(options =>
{
 // --- Configure Core API Options --- 
 options.ServiceName = "MyMicroservice";
 options.ServiceDescription = "Provides core business logic.";
 // --- Toggle Features --- 
 // options.TurnOff.OData = true; // Example: Disable OData
 // options.TurnOff.Dapr = true; // Example: Disable Dapr (and related features)
 // --- Custom Configuration Actions --- 
 options.ODataBuilder = modelBuilder =>
 {
 // Configure your OData model here
 // modelBuilder.EntitySet<Product>("Products");
 };
 options.HealthChecks = healthChecksBuilder =>
 {
 // Add custom health checks
 // healthChecksBuilder.AddCheck<MyCustomHealthCheck>("custom_check");
 };
}, args);
// --- Register Application Services ---
// builder.Services.AddScoped<IMyService, MyService>();
// --- Register DbContext (if using VegaDbContext) ---
// Must inherit from VegaDbContext
// builder.Services.AddDbContext<MyAppContext>(); 
var app = builder.Build();
// --- Apply Vega Middleware & Initializers ---
app.UseVegaApiDefaults(); 
// --- Configure Standard ASP.NET Core Middleware ---
// app.UseHttpsRedirection(); 
app.UseAuthentication();
app.UseAuthorization();
app.MapControllers();
// Optional: Map Dapr subscription handler if using pub/sub
// app.MapSubscribeHandler(); 
app.Run();

Documentation

For detailed information on configuration and features, please refer to the documentation in the docs folder:

• Main Documentation Index

Key areas include:

• Configuring VegaApiOptions
• Using CreateVegaApi and UseVegaApiDefaults
• Configuration via appsettings.json and Environment Variables
• Using VegaDbContext
• Dapr Distributed Cache
• Remote Configuration

Contributing

[Details on contributing, code of conduct, etc.]

License

[License information]