OpenApiSchemaTuner.Net
2.0.0.1
dotnet add package OpenApiSchemaTuner.Net --version 2.0.0.1
NuGet\Install-Package OpenApiSchemaTuner.Net -Version 2.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="OpenApiSchemaTuner.Net" Version="2.0.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="OpenApiSchemaTuner.Net" Version="2.0.0.1" />
<PackageReference Include="OpenApiSchemaTuner.Net" />
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 OpenApiSchemaTuner.Net --version 2.0.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: OpenApiSchemaTuner.Net, 2.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.
#addin nuget:?package=OpenApiSchemaTuner.Net&version=2.0.0.1
#tool nuget:?package=OpenApiSchemaTuner.Net&version=2.0.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
OpenApi Schema Tuner
A .NET helper library for generating OpenAPI schema definitions from fluent metadata or custom configurations.
Features
- Describe enums in request parameter as user friendly list.
- Describe enums in request body schema.
- Describe enums in response body schema.
- Ability to add schema property description.
- Ability to add request parameter description.
- Ability to add controller description.
- Guest tag for endpoints with Anonymous authentication.
- Mark endpoint as deprecated with a message and clickable link to the new endpoint.
- Mark request parameter as deprecated with a message.
- Endpoint request examples.
- Normalized api paths with lowercase.
- Ability to group endpoints.
- Auto group deprecated endpoints.
- Ability to ignore request parameter.
- More will be implemented later.
Getting Started
Installation
You can install the package via NuGet Package Manager:
Install-Package OpenApiSchemaTuner.Net
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | 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 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.
-
net9.0
- Microsoft.AspNetCore.OpenApi (>= 9.0.5)
- Microsoft.OpenApi (>= 1.6.24)
- Swashbuckle.AspNetCore.SwaggerGen (>= 8.1.2)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.