Vernou.Swashbuckle.HttpResultsAdapter 1.0.2

.NET 7.0 This package targets .NET 7.0. The package is compatible with this framework or higher. 
dotnet add package Vernou.Swashbuckle.HttpResultsAdapter --version 1.0.2
                    


                    

                
NuGet\Install-Package Vernou.Swashbuckle.HttpResultsAdapter -Version 1.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="Vernou.Swashbuckle.HttpResultsAdapter" Version="1.0.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Vernou.Swashbuckle.HttpResultsAdapter" Version="1.0.2" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Vernou.Swashbuckle.HttpResultsAdapter" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Vernou.Swashbuckle.HttpResultsAdapter --version 1.0.2
                    


                    

                
#r "nuget: Vernou.Swashbuckle.HttpResultsAdapter, 1.0.2"
#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. 
#addin nuget:?package=Vernou.Swashbuckle.HttpResultsAdapter&version=1.0.2
                    


                            Install Vernou.Swashbuckle.HttpResultsAdapter as a Cake Addin
                        

                    

                
#tool nuget:?package=Vernou.Swashbuckle.HttpResultsAdapter&version=1.0.2
                    


                            Install Vernou.Swashbuckle.HttpResultsAdapter as a Cake Tool

Vernou.Swashbuckle.HttpResultsAdapter

Vernou.Swashbuckle.HttpResultsAdapter is a NuGet package that extend Swashbuckle.AspNetCore to generate Open Api responses to action that returns type from the namespace Microsoft.AspNetCore.Http.HttpResult.

Why?

.NET 7 introduce Typed Http Results, but Swashbuckle don't generate the Open Api Response from this types.\

See this issue for more detail :
TypedResults metadata are not inferred for API Controllers

Getting started

Install the package Vernou.Swashbuckle.HttpResultsAdapter :

dotnet add package Vernou.Swashbuckle.HttpResultsAdapter

Add the operation filter like :

builder.Services
    .AddSwaggerGen(options =>
    {
        ...
        options.OperationFilter<HttpResultsOperationFilter>();
    });

Enjoy convenient Typed Http Results.

Contributing

This project welcomes contributions and suggestions.

License

Vernou.Swashbuckle.HttpResultsAdapter is licensed under the MIT license.

Product Compatible and additional computed target framework versions.
.NET net7.0 is compatible.  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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows 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
1.0.2 41,439 10/22/2023
1.0.1 1,051 10/8/2023
1.0.0 191 10/4/2023