SwaggerSchemaExample.Nuget 1.0.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package SwaggerSchemaExample.Nuget --version 1.0.0
                    


                    

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


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="SwaggerSchemaExample.Nuget" />
                    


                            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 SwaggerSchemaExample.Nuget --version 1.0.0
                    


                    

                
#r "nuget: SwaggerSchemaExample.Nuget, 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. 
#:package SwaggerSchemaExample.Nuget@1.0.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=SwaggerSchemaExample.Nuget&version=1.0.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=SwaggerSchemaExample.Nuget&version=1.0.0
                    


                            Install as a Cake Tool

SwaggerSchemaExample

This library allows you to document models and DTOs with Swagger.

These are the steps to follow.

Swagger Settings

  • Add EnableAnnotations and implement SwaggerSchemaExampleFilterin SchemaFilter.
builder.Services.AddSwaggerGen(
    options =>
    {
        options.EnableAnnotations();
        // options.SwaggerDoc("v1", new OpenApiInfo { Title = "DemoSwaggerAnnotation", Version = "v1" });
         options.SchemaFilter<SwaggerSchemaExampleFilter>();
    });

Finished

Now we can add the annotations to our models and DTOs

 public class WeatherForecast
    {

        [SwaggerSchema(Description = "Date and time for weather")]
        [SwaggerSchemaExample("2021-10-30T10:42:53.531Z")]
        public DateOnly Date { get; set; }

        [SwaggerSchema(Description = "Temperature in celcius")]
        [SwaggerSchemaExample("40")]
        public int TemperatureC { get; set; }

        [SwaggerSchema(Description = "Temperature in fahrenheit")]
        [SwaggerSchemaExample("103")]
        public int TemperatureF => 32 + (int)(TemperatureC / 0.5556);

        [SwaggerSchema(Description = "Summary weather forecast ")]
        [SwaggerSchemaExample("Sweltering")]
        public string? Summary { get; set; }
    }

Original Source

link

Author

@niteshsinghal85 Nitesh Singhal

Dario Marzzucco

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 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.

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 86 8/3/2025

First Version