FSharp.SystemTextJson.Swagger 0.0.2

.NET 6.0
dotnet add package FSharp.SystemTextJson.Swagger --version 0.0.2
NuGet\Install-Package FSharp.SystemTextJson.Swagger -Version 0.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="FSharp.SystemTextJson.Swagger" Version="0.0.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add FSharp.SystemTextJson.Swagger --version 0.0.2
#r "nuget: FSharp.SystemTextJson.Swagger, 0.0.2"
#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 FSharp.SystemTextJson.Swagger as a Cake Addin
#addin nuget:?package=FSharp.SystemTextJson.Swagger&version=0.0.2

// Install FSharp.SystemTextJson.Swagger as a Cake Tool
#tool nuget:?package=FSharp.SystemTextJson.Swagger&version=0.0.2

FSharp.SystemTextJson.Swagger

Swagger settings for FSharp.SystemTextJson. Still experimantal

Usage

Only replace AddSwaggerGen with AddSwaggerForSystemTextJson

let builder =  WebApplication.CreateBuilder(args)
let fsOptions = JsonFSharpOptions() // setup options here 
//setup usage of JsonFSharpConverter                
builder.Services.AddControllers()
                    .AddJsonOptions(fun opts ->
                        opts.JsonSerializerOptions.Converters.Add(JsonFSharpConverter(fsOptions))) 
// setup usage of SwaggerForSystemTextJson - use instead AddSwaggerGen 
builder.Services.AddSwaggerForSystemTextJson(fsOptions)
        
let app = builder.Build()
        
if (app.Environment.IsDevelopment()) then
      app.UseSwagger() |> ignore
      app.UseSwaggerUI() |> ignore

What works

Not everything is now implemented. Some things works with limitations

Records

  • Works
  • All properties are required except of Skippable
  • Option properties are set as nullable

Tuples

  • Works
  • Evaluates to array of composed type
  • Array has length limits to tuple length
  • Composed type is made as oneOf keyType and valueType
  • Warning - request generated by this schema could be invalid.

Collections

  • List and Set: works
  • Maps
    • with string keys - works
    • with boxed string - works
    • other - works
      • Evaluates to array of Tuples.
      • Warning - request generated by this schema could be invalid

Unions

  • Almost every setup combinations works
  • Still experimental
Product Versions
.NET net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
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
0.0.2 170 11/14/2022
0.0.1 155 11/7/2022