Swashbuckle.NodaTime.AspNetCore 1.1.0

.NET Standard 1.6 This package targets .NET Standard 1.6. The package is compatible with this framework or higher. .NET Framework 4.5.1 This package targets .NET Framework 4.5.1. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Swashbuckle.NodaTime.AspNetCore --version 1.1.0                

                    
                

            
NuGet\Install-Package Swashbuckle.NodaTime.AspNetCore -Version 1.1.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="Swashbuckle.NodaTime.AspNetCore" Version="1.1.0" />
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.0                

                    
                

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

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

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.1.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 Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  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 was computed.  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 was computed.  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. 
.NET Core netcoreapp1.0 was computed.  netcoreapp1.1 was computed.  netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard1.6 is compatible.  netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net451 is compatible.  net452 was computed.  net46 was computed.  net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen30 was computed.  tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos 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,171 3/20/2024
5.0.1 64,899 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,297 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/blob/master/CHANGELOG.md