EngineBay.ApiDocumentation 2.0.8

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package EngineBay.ApiDocumentation --version 2.0.8
                    


                    

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


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="EngineBay.ApiDocumentation" />
                    


                            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 EngineBay.ApiDocumentation --version 2.0.8
                    


                    

                
#r "nuget: EngineBay.ApiDocumentation, 2.0.8"
#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. 
#:package EngineBay.ApiDocumentation@2.0.8
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=EngineBay.ApiDocumentation&version=2.0.8
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=EngineBay.ApiDocumentation&version=2.0.8
                    


                            Install as a Cake Tool

EngineBay.ApiDocumentation

NuGet version Maintainability Test Coverage

ApiDocumentation module for EngineBay published to EngineBay.ApiDocumentation on NuGet.

About

This module will add middleware to generate and expose Swagger UI documentation for all the endpoints in your project. Swagger uses the OpenAPI 3 specification.

Usage

The Swagger documentation is generated entirely automatically if this module is enabled.

If you wish to browse the documentation generated for your project, you can start the application and visit /swagger/index.html.

Registration

This module cannot run on its own. You will need to register it in your application to use its functionality. See the Demo API registration guide.

Environment Variables

See the Documentation Portal.

Dependencies

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  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.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.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
2.0.8 164 2/15/2024
2.0.7 216 1/30/2024
2.0.6 222 1/10/2024
2.0.5 219 12/20/2023
2.0.4 250 12/7/2023
2.0.3 152 12/7/2023
2.0.2 169 12/7/2023
2.0.1 209 11/29/2023
2.0.0 159 11/24/2023
1.1.0 213 11/15/2023
1.0.5 226 11/3/2023
1.0.4 220 10/31/2023
1.0.3 186 10/31/2023
1.0.2 189 10/26/2023
1.0.1 159 10/10/2023
1.0.0 303 9/28/2023
0.2.10 187 9/26/2023
0.2.9 178 9/24/2023
0.2.8 157 9/21/2023
0.2.7 260 6/2/2023
0.2.6 241 4/9/2023
0.2.5 329 4/2/2023
0.2.4 264 3/27/2023
0.2.3 349 3/27/2023
0.2.2 276 3/27/2023
0.2.1 277 3/26/2023
0.2.0 271 3/26/2023
0.1.0 278 3/26/2023