AzureFunctions.Worker.Extensions.Swashbuckle 2.0.1

.NET 9.0

dotnet add package AzureFunctions.Worker.Extensions.Swashbuckle --version 2.0.1

NuGet\Install-Package AzureFunctions.Worker.Extensions.Swashbuckle -Version 2.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="AzureFunctions.Worker.Extensions.Swashbuckle" Version="2.0.1" />

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

paket add AzureFunctions.Worker.Extensions.Swashbuckle --version 2.0.1

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

#r "nuget: AzureFunctions.Worker.Extensions.Swashbuckle, 2.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 AzureFunctions.Worker.Extensions.Swashbuckle as a Cake Addin
#addin nuget:?package=AzureFunctions.Worker.Extensions.Swashbuckle&version=2.0.1

// Install AzureFunctions.Worker.Extensions.Swashbuckle as a Cake Tool
#tool nuget:?package=AzureFunctions.Worker.Extensions.Swashbuckle&version=2.0.1

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

Swashbuckle API explorer for Azure Functions

Use Swashbuckle (Swagger UI) api explorer with zero midifications to your code
Get full Swagger extensibility as in MVC

NuGet package

v1 https://www.nuget.org/packages/AzureFunctions.Worker.Extensions.AspNetCore.ApiExplorer

v2 https://www.nuget.org/packages/AzureFunctions.Worker.Extensions.Swashbuckle

🔴Migration to v2 Azure Functions SDK🔴

Microsoft suggest to use FunctionsApplicationBuilder over generic HostBuilder that is why v2 package will only support this api.

var host = new HostBuilder()
    .ConfigureServices((hostingContext, services) =>
    {
        // additional worker services configuration
    })
    .ConfigureFunctionsWebApplication(worker =>
    {
        worker
            .AddAspNetCoreIntegration()
            .AddMvcOptions(mvcOptions =>
            {
                // additional MVC options customization
            });

        worker.UseAspNetCoreMiddleware(app =>
        {
            app.UseFunctionSwaggerUI();  // <--- magic happens here
        });
    })
    .Build();

var builder = FunctionsApplication.CreateBuilder(args);

// should be used for HTTP triggered APIs
builder.ConfigureFunctionsWebApplication();

// should be called after "ConfigureFunctionsWebApplication"
builder
    .ConfigureAspNetCoreMvcIntegration()
    .AddMvcOptions(mvcOptions =>
    {
        // additional MVC options customization
    });

builder.UseAspNetCoreMiddleware(app =>
{
    app.UseFunctionSwaggerUI();  // <--- magic happens here
});

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.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net9.0
- AzureFunctions.Worker.Extensions.AspNetCore (>= 2.0.1)
- Swashbuckle.AspNetCore (>= 7.2.0)
- Swashbuckle.AspNetCore.Annotations (>= 7.2.0)

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.1	41	1/16/2025
2.0.0	56	1/10/2025