Swashbuckle.NodaTime.AspNetCore 1.1.3

.NET Standard 1.6 .NET Framework 4.5.1
There is a newer version of this package available.
See the version list below for details. 
Install-Package Swashbuckle.NodaTime.AspNetCore -Version 1.1.3
dotnet add package Swashbuckle.NodaTime.AspNetCore --version 1.1.3
<PackageReference Include="Swashbuckle.NodaTime.AspNetCore" Version="1.1.3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Swashbuckle.NodaTime.AspNetCore --version 1.1.3
The NuGet Team does not provide support for this client. Please contact its maintainers for support. 
#r "nuget: Swashbuckle.NodaTime.AspNetCore, 1.1.3"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. 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=1.1.3

// Install Swashbuckle.NodaTime.AspNetCore as a Cake Tool
#tool nuget:?package=Swashbuckle.NodaTime.AspNetCore&version=1.1.3
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Swashbuckle.NodaTime.AspNetCore

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:

<img src="https://raw.githubusercontent.com/buvinghausen/Swashbuckle.NodaTime.AspNetCore/master/images/not-enabled.png" width="700">

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

<img src="https://raw.githubusercontent.com/buvinghausen/Swashbuckle.NodaTime.AspNetCore/master/images/enabled.png" width="700">

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 2.5.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 Info
      {
        Title = "My NodaTime API",
        Version = "v1"
      });
      c.ConfigureForNodaTime();
    });
  }
}

NuGet

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
.NET Core netcoreapp1.0 netcoreapp1.1 netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard1.6 netstandard2.0 netstandard2.1
.NET Framework net451 net452 net46 net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen30 tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
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
4.0.1 35,994 9/16/2021
4.0.0 289 9/15/2021
3.0.0 43,004 7/31/2020
2.0.0 66,326 12/4/2018
1.2.0 2,082 12/4/2018
1.1.3 11,531 7/13/2018
1.1.2 5,166 2/26/2018
1.1.0 809 2/25/2018
1.0.1 820 2/25/2018
1.0.0 2,390 12/14/2017

See https://github.com/buvinghausen/Swashbuckle.NodaTime.AspNetCore/blob/master/CHANGELOG.md