Wisp.Extensions.OpenApi 1.0.0

.NET 9.0

dotnet add package Wisp.Extensions.OpenApi --version 1.0.0

NuGet\Install-Package Wisp.Extensions.OpenApi -Version 1.0.0

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="Wisp.Extensions.OpenApi" Version="1.0.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="Wisp.Extensions.OpenApi" Version="1.0.0" />
                    

                            Directory.Packages.props

<PackageReference Include="Wisp.Extensions.OpenApi" />
                    

                            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 Wisp.Extensions.OpenApi --version 1.0.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Wisp.Extensions.OpenApi, 1.0.0"

#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 Wisp.Extensions.OpenApi@1.0.0

#: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=Wisp.Extensions.OpenApi&version=1.0.0
                    

                            Install as a Cake Addin

#tool nuget:?package=Wisp.Extensions.OpenApi&version=1.0.0
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Wisp.Extensions.OpenApi

This extension adds an OpenAPI schema generator and a Swagger UI endpoint.

Installation

Add the Wisp.Extensions.OpenApi NuGet package.

Enable the extension in your WispHostBuilder:

hostBuilder.UseOpenApi(c => 
    c
      .Title("Demo")
      .Version("1.0.0")
      .InAssembly(Assembly.GetExecutingAssembly())
    
      .OpenApiSpecPath("/openapi/schema.json") // Optional
      .SwaggerUiPath("/openapi/swagger") // Optional
);

And map the appropriate endpoints in your WispApplicationBuilder:

applicationBuilder.MapOpenApi();

Usage

The extension will automatically scan for controllers annotated with [ApiController]. It will pick up all routes in that controller with a valid [Route] attribute.

If a controller has a doc comment, the summary section will be shown in Swagger. Same goes for route methods.

By default, the schema will be available at /openapi/schema.json and Swagger UI will be available at /openapi/swagger.

Product	Compatible and additional computed target framework versions.
.NET	net9.0 is compatible. 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.

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net9.0
- Microsoft.OpenApi (>= 2.3.1)
- NSwag.Core (>= 14.6.0)
- Wisp.Framework.Core (>= 1.0.0)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.