APF.Core.Clean.OpenApi 10.0.0.1

.NET 10.0 This package targets .NET 10.0. The package is compatible with this framework or higher.
There is a newer prerelease version of this package available.
See the version list below for details. 
dotnet add package APF.Core.Clean.OpenApi --version 10.0.0.1
                    


                    

                
NuGet\Install-Package APF.Core.Clean.OpenApi -Version 10.0.0.1
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.OpenApi" Version="10.0.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="APF.Core.Clean.OpenApi" Version="10.0.0.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="APF.Core.Clean.OpenApi" />
                    


                            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.OpenApi --version 10.0.0.1
                    


                    

                
#r "nuget: APF.Core.Clean.OpenApi, 10.0.0.1"
#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.OpenApi@10.0.0.1
#: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.OpenApi&version=10.0.0.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=APF.Core.Clean.OpenApi&version=10.0.0.1
                    


                            Install as a Cake Tool

Core.Clean.OpenApi

Core.Clean.OpenApi is an infrastructure-level package that provides OpenAPI/Swagger documentation generation, AWS API Gateway integration metadata, and access-control tagging for microservices following Clean Architecture.

It supports two approaches: Swashbuckle-based (SwaggerServiceExtensions) for existing services, and .NET 10 native OpenAPI + Scalar (ScalarServiceExtensions) for new/migrated services. Both can run side by side.

Projects

src/Core.Clean.OpenApi

  • Core.Clean.OpenApi

tests/Core.Clean.OpenApi.Tests

  • Core.Clean.OpenApi.Tests

Purpose

  • Generates OpenAPI documentation via Swashbuckle or .NET 10 native OpenAPI.
  • Injects AWS API Gateway integration and authorizer metadata for Lambda proxy deployments.
  • Applies consistent access-control and security tagging across operations and schemas.

Features

  • Operation filters/transformers: AWS Gateway metadata, standard error responses, access-control tagging, security requirements from [Authorize].
  • Document filters/transformers: CORS OPTIONS injection, secureaccess schema tagging, tag removal.
  • Schema filters/transformers: enum handling, required-property enforcement, [SwaggerIgnore] support.

Usage

// Swashbuckle
builder.Services.AddSwaggerGen();
builder.Services.ConfigureSwaggerGen<YourRequestExample>(
    new SwaggerConfigurationSettings
    {
        AwsApiGatewayIntegration = new AwsApiGatewayIntegration(DefaultConstants.ProjectName)
    });

// .NET 10 native + Scalar
builder.Services.ConfigureOpenApi(swaggerSettings, groupName: "v1");

AwsApiGatewayIntegration/ApiGatewayAuthorizer must be populated explicitly per project — a bare new SwaggerConfigurationSettings() produces an empty integration uri.

Getting Started

  1. Clone the repo
  2. Navigate to the root directory
  3. Run:
dotnet build
dotnet test
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
10.0.1.1-Beta-05 82 8/31/2026
10.0.1.1-Beta-04 79 8/27/2026
10.0.1.1-Beta-03 90 8/19/2026
10.0.1.1-Beta-02 335 8/18/2026
10.0.1.1-Beta-01 88 8/17/2026
10.0.0.2-Beta-01 86 8/27/2026
10.0.0.1 305 8/17/2026
10.0.0-Beta-11 762 8/4/2026
10.0.0-Beta-10 146 7/20/2026
10.0.0-Beta-09 89 7/20/2026
10.0.0-Beta-08 93 7/17/2026
10.0.0-Beta-07 94 7/17/2026
10.0.0-Beta-06 116 7/17/2026
10.0.0-Beta-05 127 7/13/2026
10.0.0-Beta-04 104 7/13/2026
10.0.0-Beta-03 106 7/10/2026
10.0.0-Beta-02 100 7/3/2026
10.0.0-Beta-01 107 6/18/2026
8.0.0.3 430 6/29/2026
8.0.0.3-Beta-1 100 6/29/2026
Loading failed

# Changelog

## 10.0.0.1 - 2026-08-17

- Release package for .NET 8 → .NET 10 migration of APF.Core.Clean.OpenApi

## 10.0.0.0-Beta-10 - 2026-07-20

- handled null ref in OptionsOperationDocumentFilter