Grad.CsLib 2.0.15

dotnet add package Grad.CsLib --version 2.0.15
                    
NuGet\Install-Package Grad.CsLib -Version 2.0.15
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Grad.CsLib" Version="2.0.15" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Grad.CsLib" Version="2.0.15" />
                    
Directory.Packages.props
<PackageReference Include="Grad.CsLib" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Grad.CsLib --version 2.0.15
                    
#r "nuget: Grad.CsLib, 2.0.15"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Grad.CsLib@2.0.15
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Grad.CsLib&version=2.0.15
                    
Install as a Cake Addin
#tool nuget:?package=Grad.CsLib&version=2.0.15
                    
Install as a Cake Tool

CsLib Core Package

This package contains utilities for C# API projects.

This package is very opinionated, as it's intended for Graduate College API projects:

  • FastEndpoints is used, which is a thin layer on top of .NET Core minimal APIs.
  • OpenAPI/Swagger docs are generated from endpoint definitions and XML documentation. The JSON is exported to the /spec folder for generating client libraries.
    • Kiota is used to generate the OpenAPI JSON, but not the client libraries.
  • Authentication is through Entra.

For local development scenarios where involving Entra isn't desirable, CsLib also provides an opt-in combined authentication mode that accepts a simple Api-Key header (see AddAuthAzureAdOrDevApiKey()).

Requirements

  • .NET Core 10

Dependencies

Outside of Microsoft packages, these are the main dependencies:

CsLibWeb

Here's an example of how to set up a Program.cs file for a web API project:

using ExampleData;
using ExampleServer;
using FastEndpoints.ClientGen.Kiota;
using Grad.CsLib;
using Grad.CsLib.ClientErrorLogging;
using Microsoft.EntityFrameworkCore;
using Serilog;

var builder = WebApplication.CreateBuilder(args);

builder.AddSwagger(args, "ExampleServer", "0.0.1", "Example Backend Server");

builder
    .AddSerilog()
    .AddCors()
    .AddAuth();
builder.Services
    .AddDbContext<ExampleContext>(options =>
        options.UseSqlServer(
            builder.Configuration.GetConnectionString("Example")))
    .AddAuthorization(AuthPolicy.AddAuthPolicy)
    .RegisterServicesFromExampleServer();

builder.AddEndpoints(DiscoveredTypes.All);

try
{
    var app = builder.BuildAndConfigureApp(b => b.ReflectionCache.AddFromExampleData().AddFromExampleServer());

    // Optional: Add client-side error logging endpoint
    app.MapClientErrorLogging("/api/client-errors");

    // This is only run with the --exportswaggerjson option
    await app.ExportSwaggerJsonAndExitAsync("ExampleServer", "../spec");

    app.Run();
}
catch (Exception ex)
{
    Log.Fatal(ex, "Application start-up failed");
}
finally
{
    Log.CloseAndFlush();
}

Development API key (optional)

If you want to allow a development-only API key as an alternative to Entra, replace AddAuth() with:

builder
    .AddSerilog()
    .AddCors()
    .AddAuthAzureAdOrDevApiKey();

Configure the expected key in configuration (for example via appsettings.Development.json):

{
  "CsLibWeb": {
    "DevApiKey": "your-dev-key"
  }
}

When the request includes the Api-Key header, API key authentication is used; otherwise CsLib falls back to Entra bearer authentication.

Client-Side Error Logging

CsLib provides a convenient endpoint for logging client-side errors. This allows frontend applications to send error information to the backend for centralized logging and analysis.

For detailed documentation, see ClientErrorLogging/README.md.

Quick example:

// In Program.cs, after building the app
app.MapClientErrorLogging("/api/client-errors");

This creates an anonymous POST endpoint that accepts client errors with validation for error type, message, stack trace, and contextual data. All errors are logged to Serilog for collection by Splunk.

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
2.0.15 81 3/18/2026
2.0.14 87 3/11/2026
2.0.13 158 2/28/2026
2.0.12 353 1/30/2026
2.0.11 147 1/29/2026
2.0.10 104 1/29/2026
2.0.9 99 1/29/2026
2.0.8 117 1/29/2026