PopValidations.Swashbuckle 1.0.0

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher. 
dotnet add package PopValidations.Swashbuckle --version 1.0.0                

                    
                

            
NuGet\Install-Package PopValidations.Swashbuckle -Version 1.0.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="PopValidations.Swashbuckle" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add PopValidations.Swashbuckle --version 1.0.0                

                    
                

            
#r "nuget: PopValidations.Swashbuckle, 1.0.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. 
// Install PopValidations.Swashbuckle as a Cake Addin
#addin nuget:?package=PopValidations.Swashbuckle&version=1.0.0

// Install PopValidations.Swashbuckle as a Cake Tool
#tool nuget:?package=PopValidations.Swashbuckle&version=1.0.0

PopValidation's Swashbuckle integration allows you to include PopValidations validation descriptions within the OpenApi specifications.

Usage

Pop Validations Swashbuckle Integration, is usable for both public and corporate use, without need for compensation, or mention. Feature or bugfix PR's, including appropriate tests are more than welcome.

Developers

The core developer is Adam Williamson(https://github.com/AdamWilliamson).

Example

PopValidation provides the ability to Describe the validations input configured for your objects. These descriptions can be imported into your OpenApi spec, using this package, with multiple configuration options. The OpenApi specification can be modified in 2 ways, by including the validation descriptions in an attribute, as well as, or instead of, modifying the OpenApi in-built validation options.

An example

using PopValidation;
using PopValidations.Swashbuckle;

// PopValidations Extensions Function for Registering The Validation Runner
builder.Services.RegisterRunner()
    // And this extension and all the Validators in the same assembly as "SongValidator"
    .RegisterAllMainValidators(typeof(BasicObjectController).Assembly);

// Register a Pop Validation Config that describes the configuration for describing the validations within OpenApi
builder.Services.RegisterPopValidationsOpenApiDefaults(new WebApiConfig());

// Inside the Swagger generator, you now just need to Add the PopValidation Filter, that will modify the OpenApi Schema
builder.Services.AddSwaggerGen(
    options =>
    {
        // Register PopValidation's Custom API decorations
        options.RegisterOpenApiModificationFilter();
    });

Full Documentation

Full documentation can be found at https://adamwilliamson.github.io/popvalidations/

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  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. 
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
1.0.0 212 12/24/2023
0.9.0.1 168 11/3/2023
0.9.0 132 10/29/2023

Working towards V1. This contains the basics needed to Ouput PopValidations to Swashbuckle's OpenApi output.