CoreSystem.OpenApi 2.1.0

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

⚡ CoreSystem.OpenApi

Base contracts and models for the CoreSystem OpenAPI infrastructure.

CoreSystem.OpenApi contains the base contracts, options and models shared by every OpenAPI provider implementation. It depends on ASP.NET Core but carries no provider-specific code, so it can be referenced on its own for the response attributes.

NuGet Downloads License .NET


✨ Features

  • ✅ Shared options, descriptors and problem-details contracts
  • ✅ Response attributes usable without any provider
  • ✅ Problem response definitions with configurable replacement modes
  • ✅ Bearer security scheme options
  • ✅ Multi-targeted for .NET 8, .NET 9 and .NET 10

📦 Installation

dotnet add package CoreSystem.OpenApi

🚀 Quick Start

Reference the package and annotate controllers with the response attributes:

using Core.OpenApi.Attributes;

[HttpPost]
[ProducesCreated<OrderResponse>]
public async Task<IActionResult> Create(CreateOrderRequest request)

🧩 Public API

Type Description
CoreProblemDetails / CoreValidationProblemDetails Problem details base types.
OpenApiOptions Common options shared by all providers.
OpenApiServerDescriptor Server entry for the document.
BearerSecurityOptions Bearer security scheme configuration.
OpenApiProblemResponsesOptions Shared problem response catalog.
ProblemResponseDefinition One response: status code, component, error code and example.
ProblemResponseReplacementMode Replacement behavior for existing responses.
ProducesOkAttribute<T> / ProducesCreatedAttribute<T> / ProducesNoContentAttribute Response attributes.
ProducesNotFoundProblemAttribute / ProducesValidationProblemAttribute / ProducesTooManyRequestsProblemAttribute Problem response attributes.

🏗 Architecture

The package is the dependency-free foundation: providers (such as Swashbuckle) build on top of these contracts and options.


📖 Documentation

  • Getting Started
  • Configuration

🤝 Contributing

Issues, discussions and pull requests are welcome.


📄 License

Released under the MIT License.

Product 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 is compatible.  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 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 CoreSystem.OpenApi:

Package Downloads
CoreSystem.OpenApi.Swashbuckle

Reusable OpenAPI and Swagger infrastructure for ASP.NET Core APIs.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
2.2.0 76 11/17/2026
2.1.0 180 11/10/2026
2.0.0 164 11/7/2026
1.0.0 105 11/1/2026

2.1.0: Added ProducesConflictProblemAttribute (HTTP 409) for documenting conflict
problem responses. Minor version bump.