APF.Core.Clean.Api 10.0.0.3-Beta-01

This is a prerelease version of APF.Core.Clean.Api.
There is a newer version of this package available.
See the version list below for details.
dotnet add package APF.Core.Clean.Api --version 10.0.0.3-Beta-01
                    
NuGet\Install-Package APF.Core.Clean.Api -Version 10.0.0.3-Beta-01
                    
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="APF.Core.Clean.Api" Version="10.0.0.3-Beta-01" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="APF.Core.Clean.Api" Version="10.0.0.3-Beta-01" />
                    
Directory.Packages.props
<PackageReference Include="APF.Core.Clean.Api" />
                    
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 APF.Core.Clean.Api --version 10.0.0.3-Beta-01
                    
#r "nuget: APF.Core.Clean.Api, 10.0.0.3-Beta-01"
                    
#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 APF.Core.Clean.Api@10.0.0.3-Beta-01
                    
#: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=APF.Core.Clean.Api&version=10.0.0.3-Beta-01&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=APF.Core.Clean.Api&version=10.0.0.3-Beta-01&prerelease
                    
Install as a Cake Tool

Core.Clean.Api

Core.Clean.Api is a cross-cutting, feature-level package that provides API-level dependencies, pagination, authentication, routing, exception handling, and versioning configurations. It serves as a foundational package that can be used across multiple microservices to standardize API behavior.

Projects

src/Core.Clean.Api

  • Core.Clean.Api

tests/Core.Clean.Api.Tests

  • Core.Clean.Api.Tests

Purpose

  • Centralizes API-related configurations such as routing, pagination, exception handling, authentication, and API versioning.
  • Provides common services like UserContextService, and TokenProvider.
  • Provides Action Filters for AccessRights and LogMethods.
  • Provides Authentication handlers for ApiKey and JWT.
  • Provides Exception handling middlewares.
  • Standardizes API behavior for all microservices while avoiding duplication.

Features

  • Routing & Constraints: Provides reusable route constraints for positive integers, non-empty strings, and valid GUIDs.
  • Authentication: JWT and API Key authentication schemes configured with TokenSettings.
  • Exception Handling: Registers global exception handler and problem details middleware.
  • Context Services: UserContextService for accessing user information.
  • Token Management: TokenProvider and JsonWebTokenHelper for managing JWT tokens.
  • API Versioning: Standardized versioning using header x-version with error response support.

Getting Started

  1. Clone the repo
  2. Navigate to the root directory
  3. Run:
dotnet build
dotnet test

register database dependencies in a microservice

using Aurionpro.PaymentFramework.Core.Clean.Api.Extensions

var builder = WebApplication.CreateBuilder(args);

// Register common api dependencies
builder.Services.AddCoreCleanApi();

// Configure authentication
builder.Services.ConfigureAuthentication(builder.Configuration);

//Configure API versioning // default is 3.0
builder.Services.ConfigureApiVersioning(majorVersion:3,minorVersion:1)
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 (1)

Showing the top 1 NuGet packages that depend on APF.Core.Clean.Api:

Package Downloads
APF.Core.Clean.ApiGateway

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
10.0.0.3 49 9/4/2026
10.0.0.3-Beta-01 59 9/3/2026
10.0.0.2 165 8/30/2026
10.0.0.2-Beta-02 101 8/28/2026
10.0.0.2-Beta-01 231 8/18/2026
10.0.0.1 378 8/14/2026
10.0.0.1-Beta-08 924 8/5/2026
10.0.0.1-Beta-07 109 8/5/2026
10.0.0.1-Beta-06 134 7/29/2026
10.0.0.1-Beta-05 107 7/21/2026
10.0.0.1-Beta-04 117 7/16/2026
10.0.0.1-Beta-03 87 7/16/2026
10.0.0.1-Beta-02 101 7/16/2026
8.0.0.16 124 8/11/2026
8.0.0.16-Beta-3 114 8/7/2026
8.0.0.16-Beta-2 210 7/15/2026
8.0.0.16-Beta-1 99 7/14/2026
8.0.0.15 439 7/10/2026
8.0.0.15-Beta-1 165 7/10/2026
8.0.0.14 169 7/9/2026
Loading failed

# Changelog

## 10.0.0.3-Beta-01 - 2026-09-03

- Added support for configurable success status codes in Result responses.

## 10.0.0.2 - 2026-08-30

- Log validation and internal server exceptions with stack traces

## 10.0.0.2-Beta-01 - 2026-08-18

- Log validation and internal server exceptions with stack traces

## 10.0.0.1 - 2026-08-14

- release package of version 10.0.0.01-Beta-08

## 10.0.0.01-Beta-08 - 2026-08-05

- updated AWSSDK.SecretsManager and Kralizek.Extensions.Configuration.AWSSecretsManager nuget versions

## 10.0.0.01-Beta-07 - 2026-08-05

- Added ASP.NET Core MVC support for API versioning (xversion)
- sln to slnx

## 10.0.0.01-Beta-06 - 2026-07-29

- PagedRequest related changes

## 10.0.0.01-Beta-05 - 2026-07-21

- corrected rbac logic for ally (changes in RBACActionFilter)

## 10.0.0.01-Beta-04 - 2026-07-16

- implemented a workaround for a known ASP.NET Core bug AddApiVersioning() corrupts the IProblemDetailsWriter registrations