APF.Core.Clean.Api
8.0.0.16-Beta-2
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.
See the version list below for details.
dotnet add package APF.Core.Clean.Api --version 8.0.0.16-Beta-2
NuGet\Install-Package APF.Core.Clean.Api -Version 8.0.0.16-Beta-2
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="8.0.0.16-Beta-2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="APF.Core.Clean.Api" Version="8.0.0.16-Beta-2" />
<PackageReference Include="APF.Core.Clean.Api" />
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 8.0.0.16-Beta-2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: APF.Core.Clean.Api, 8.0.0.16-Beta-2"
#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@8.0.0.16-Beta-2
#: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=8.0.0.16-Beta-2&prerelease
#tool nuget:?package=APF.Core.Clean.Api&version=8.0.0.16-Beta-2&prerelease
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
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, andTokenProvider. - 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:
UserContextServicefor accessing user information. - Token Management:
TokenProviderandJsonWebTokenHelperfor managing JWT tokens. - API Versioning: Standardized versioning using header
x-versionwith error response support.
Getting Started
- Clone the repo
- Navigate to the root directory
- 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 | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. 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.
-
net8.0
- Amazon.Lambda.APIGatewayEvents (>= 2.7.1)
- APF.Core.Clean.Common (>= 8.0.0.21-Beta-01)
- AWSSDK.SecretsManager (>= 3.7.400.13)
- FluentValidation (>= 11.11.0)
- FluentValidation.AspNetCore (>= 11.3.0)
- Hashids.net (>= 1.7.0)
- Kralizek.Extensions.Configuration.AWSSecretsManager (>= 1.7.0)
- MediatR (>= 12.4.1)
- Microsoft.AspNetCore.Authentication.JwtBearer (>= 8.0.8)
- Microsoft.AspNetCore.Mvc.Versioning (>= 2.3.0)
- Swashbuckle.AspNetCore.Annotations (>= 6.8.1)
- Swashbuckle.AspNetCore.Filters (>= 8.0.2)
- Swashbuckle.AspNetCore.Swagger (>= 7.2.0)
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.5 | 115 | 9/11/2026 |
| 10.0.0.5-Beta-01 | 81 | 9/10/2026 |
| 10.0.0.4 | 152 | 9/9/2026 |
| 10.0.0.4-Beta-01 | 129 | 9/8/2026 |
| 10.0.0.3 | 139 | 9/4/2026 |
| 10.0.0.3-Beta-01 | 120 | 9/3/2026 |
| 10.0.0.2 | 334 | 8/30/2026 |
| 10.0.0.2-Beta-02 | 109 | 8/28/2026 |
| 10.0.0.2-Beta-01 | 242 | 8/18/2026 |
| 10.0.0.1 | 402 | 8/14/2026 |
| 10.0.0.1-Beta-08 | 1,078 | 8/5/2026 |
| 10.0.0.1-Beta-07 | 115 | 8/5/2026 |
| 10.0.0.1-Beta-06 | 139 | 7/29/2026 |
| 10.0.0.1-Beta-05 | 112 | 7/21/2026 |
| 10.0.0.1-Beta-04 | 119 | 7/16/2026 |
| 10.0.0.1-Beta-03 | 92 | 7/16/2026 |
| 10.0.0.1-Beta-02 | 105 | 7/16/2026 |
| 8.0.0.16 | 133 | 8/11/2026 |
| 8.0.0.16-Beta-3 | 120 | 8/7/2026 |
| 8.0.0.16-Beta-2 | 218 | 7/15/2026 |
Loading failed
# Changelog
## 8.0.0.16-Beta-2 - 2026-07-15
- added RemoveOptionsOperationDocumentFilter