Swashbuckle.NodaTime.AspNetCore 1.1.0

Configure Swashbuckle.AspNetCore to generate correct documentation for NodaTime types. Documentation uses JSON Schema's 'example' attribute to show the resulting value.

There is a newer version of this package available.
See the version list below for details.
Install-Package Swashbuckle.NodaTime.AspNetCore -Version 1.1.0
dotnet add package Swashbuckle.NodaTime.AspNetCore --version 1.1.0
<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
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.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

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

Release Notes

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

This package is not used by any popular GitHub repositories.

Version History

Version Downloads Last updated
2.0.0 18,376 12/4/2018
1.2.0 869 12/4/2018
1.1.3 10,177 7/13/2018
1.1.2 3,845 2/26/2018
1.1.0 239 2/25/2018
1.0.1 232 2/25/2018
1.0.0 1,767 12/14/2017
Show less