JsonOptional 0.0.1
dotnet add package JsonOptional --version 0.0.1
NuGet\Install-Package JsonOptional -Version 0.0.1
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="JsonOptional" Version="0.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add JsonOptional --version 0.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: JsonOptional, 0.0.1"
#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 JsonOptional as a Cake Addin #addin nuget:?package=JsonOptional&version=0.0.1 // Install JsonOptional as a Cake Tool #tool nuget:?package=JsonOptional&version=0.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
JsonOptional
Allows you to represent values that might be missing in a JSON document in .NET.
Examples
Deserialize using Optional
s:
using System;
using System.Text.Json;
using JsonOptional;
const string json = "{ \"FirstName\": \"John\", \"LastName\": \"Doe\" }";
var up = JsonSerializer.Deserialize<Person>(json, new JsonSerializerOptions
{
Converters = { new OptionalJsonConverterFactory() }
});
Console.WriteLine(p.FirstName.Value == "John");
Console.WriteLine(p.MiddleName.HasValue);
Console.WriteLine(p.LastName.Value == "Doe");
// Result:
// True
// False
// True
public class Person
{
public Optional<string> FirstName { get; set; }
public Optional<string> MiddleName { get; set; }
public Optional<string> LastName { get; set; }
}
Using with ASP.NET Core for merge patching:
// Startup.cs or Program.cs
using JsonOptional;
using Microsoft.AspNetCore.Mvc.ModelBinding;
// ...
services
.AddControllers(opts =>
{
opts.ModelMetadataDetailsProviders.Add(
new SuppressChildValidationMetadataProvider(typeof(IOptional)));
})
.AddJsonOptions(opts => opts.JsonSerializerOptions.Converters.Add(new OptionalJsonConverterFactory()));
using JsonOptional;
using Microsoft.AspNetCore.Mvc;
public class Person
{
public string FirstName { get; set; }
public string MiddleName { get; set; }
public string LastName { get; set; }
}
public class UpdatePerson
{
public Optional<string> FirstName { get; set; }
public Optional<string> MiddleName { get; set; }
public Optional<string> LastName { get; set; }
}
[ApiController]
[Route("[controller]")]
public class PeopleController : ControllerBase
{
private static readonly List<Person> People = new()
{
new() { FirstName = "John", MiddleName = "Jay", LastName = "Do" },
};
[HttpGet]
public List<Person> Get()
{
return People;
}
[HttpPost]
public Person Add(Person p)
{
People.Add(p);
return p;
}
[HttpPatch("{i:int}")]
public ActionResult<Person> Patch(int i, UpdatePerson up)
{
var p = People.ElementAtOrDefault(i);
if (p is null)
{
return NotFound();
}
if (up.FirstName.HasValue) p.FirstName = up.FirstName.Value;
if (up.MiddleName.HasValue) p.MiddleName = up.MiddleName.Value;
if (up.LastName.HasValue) p.LastName = up.LastName.Value;
return Ok(p);
}
}
Annotations
JsonOptional.Annotations
adds Optional
-friendly alternatives to the most common data and validation annotations.
[OptionalNotNull]
[OptionalStringLength(200, Minimum = 1)]
public Optional<string> FirstName { get; init; }
[OptionalNotNull]
[OptionalUrl]
public Optional<string> Website { get; init; }
[OptionalNotNull]
[OptionalEmail]
public Optional<string> Email { get; init; }
Product | Versions 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 | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | 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 | 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.
-
.NETStandard 2.0
- System.ComponentModel.Annotations (>= 5.0.0)
- System.Text.Json (>= 6.0.1)
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 |
---|---|---|
0.0.1 | 2,024 | 1/5/2022 |
Initial release