Swashbuckle.NodaTime.AspNetCore 5.0.2

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher. 
dotnet add package Swashbuckle.NodaTime.AspNetCore --version 5.0.2                

                    
                

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

                    
                

            
#r "nuget: Swashbuckle.NodaTime.AspNetCore, 5.0.2"
#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 Swashbuckle.NodaTime.AspNetCore as a Cake Addin
#addin nuget:?package=Swashbuckle.NodaTime.AspNetCore&version=5.0.2

// Install Swashbuckle.NodaTime.AspNetCore as a Cake Tool
#tool nuget:?package=Swashbuckle.NodaTime.AspNetCore&version=5.0.2

Swashbuckle.NodaTime.AspNetCore

Continuous IntegrationNuGetLicense: MIT

Easily configure Swashbuckle.AspNetCore to generate correct documentation for NodaTime types.

NodaTime is an alternative date and time API for .NET which is often used to replace built in types for handling date and time. It can be easily configured to work nicely with ASP.NET Core MVC using NodaTime.Serialization.JsonNet package.

Swashbuckle.AspNetCore is a library to seamlesly add swagger generation and UI to ASP.NET Core MVC projects.

The problem is that by default swagger generated by Swashbuckle.AspNetCore doesn't show NodaTime types nicely as can be seen on the following picture:

Not-Enabled

Swashbuckle.NodaTime.AspNetCore configures Swashbuckle.AspNetCore to show NodaTime types as they will be really deserialized:

Enabled

Installation

Install from NuGet: https://www.nuget.org/packages/Swashbuckle.NodaTime.AspNetCore.

Run the following command in the Package Manager Console:

Install-Package Swashbuckle.NodaTime.AspNetCore

Usage

Call ConfigureForNodaTime method on swagger configuration when setting up swagger using AddSwaggerGen method.

Check the example which uses Swashbuckle.AspNetCore version 5.0.0

public class Startup
{
  public void ConfigureServices(IServiceCollection services)
  {
    // This example is using JSON.NETs default settings function with some sample overrides
    // You may also pass the settings object directly into the ConfigureForNodaTime function
    JsonConvert.DefaultSettings = () => new JsonSerializerSettings
    {
      ContractResolver = new CamelCasePropertyNamesContractResolver(),
      Converters = { new StringEnumConverter() },
      NullValueHandling = NullValueHandling.Ignore
    }.ConfigureForNodaTime(DateTimeZoneProviders.Tzdb);

    services.AddSwaggerGen(c =>
    {
      c.SwaggerDoc("v1", new OpenApiInfo
      {
        Title = "My NodaTime API",
        Version = "v1"
      });
      c.ConfigureForNodaTime();
    });
  }
}
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
5.0.2 44,217 3/20/2024
5.0.1 64,905 2/28/2023
5.0.0 19,407 11/8/2022
5.0.0-rc1-001 287 10/18/2022
4.0.1 86,026 9/16/2021
4.0.0 496 9/15/2021
3.0.0 49,479 7/31/2020
2.0.0 71,299 12/4/2018
1.2.0 2,363 12/4/2018
1.1.3 11,950 7/13/2018
1.1.2 5,424 2/26/2018
1.1.0 1,088 2/25/2018
1.0.1 1,089 2/25/2018
1.0.0 2,707 12/14/2017

See https://github.com/buvinghausen/Swashbuckle.NodaTime.AspNetCore/releases/tag/5.0.2