AzureExtensions.Swashbuckle 3.1.0-beta

This is a prerelease version of AzureExtensions.Swashbuckle.
There is a newer version of this package available.
See the version list below for details.
dotnet add package AzureExtensions.Swashbuckle --version 3.1.0-beta                
NuGet\Install-Package AzureExtensions.Swashbuckle -Version 3.1.0-beta                
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="AzureExtensions.Swashbuckle" Version="3.1.0-beta" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add AzureExtensions.Swashbuckle --version 3.1.0-beta                
#r "nuget: AzureExtensions.Swashbuckle, 3.1.0-beta"                
#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 AzureExtensions.Swashbuckle as a Cake Addin
#addin nuget:?package=AzureExtensions.Swashbuckle&version=3.1.0-beta&prerelease

// Install AzureExtensions.Swashbuckle as a Cake Tool
#tool nuget:?package=AzureExtensions.Swashbuckle&version=3.1.0-beta&prerelease                

azure-functions-extensions-swashbuckle

Swagger tooling for API's built with Azure Functions.

This product aims to easily provide Swagger and Swagger UI of APIs created in Azure Functions using Swashbuckle.AspNetCore.


3.1.0

Breaking:

Option and DocumentOption renamed to SwaggerDocOptions and SwaggerDocument respectivly and moved to AzureFunctions.Extensions.Swashbuckle.Settings namespace

Properties renamed:

PrepandOperationWithRoutePrefix ⇒ PrependOperationWithRoutePrefix AddCodeParamater ⇒ AddCodeParameter

Versions:

Updated to Swagger 5.3.1 Updated UI to v3.24.0 version to support both 2/3 OpenAPI versions correctly

Size:

All the resources are places in zip archive in order to decrease result dll size by 357% (from 1.5mb to 460kb)


3.0.0

  • Updated to v3 Functions
  • Updated to 5.0.0 Swashbuckle.AspNetCore nugets
  • Merged PRs to fix issues related to RequestBodyType and Ignore attribute
  • application/json is a default media type.

Sample

https://github.com/vitalybibikov/azure-functions-extensions-swashbuckle/tree/master/sample

Update

Version 3.0.0

Getting Started

  1. Install the standard Nuget package into your Azure Functions application.
Package Manager : Install-Package AzureExtensions.Swashbuckle
CLI : dotnet add package AzureExtensions.Swashbuckle
  1. Add startup class on your Functions project.
[assembly: WebJobsStartup(typeof(SwashBuckleStartup))]
namespace YourAppNamespace
{
    internal class SwashBuckleStartup : IWebJobsStartup
    {
        public void Configure(IWebJobsBuilder builder)
        {
            //Register the extension
            builder.AddSwashBuckle(Assembly.GetExecutingAssembly());

        }
    }
}
  1. Add swagger and swagger ui endpoint functions on your project.
public static class SwaggerController
{
    [SwaggerIgnore]
    [FunctionName("Swagger")]
    public static Task<HttpResponseMessage> Run(
        [HttpTrigger(AuthorizationLevel.Function, "get", Route = "Swagger/json")] HttpRequestMessage req,
        [SwashBuckleClient]ISwashBuckleClient swashBuckleClient)
    {
        return Task.FromResult(swashBuckleClient.CreateSwaggerDocumentResponse(req));
    }

    [SwaggerIgnore]
    [FunctionName("SwaggerUi")]
    public static Task<HttpResponseMessage> Run2(
        [HttpTrigger(AuthorizationLevel.Function, "get", Route = "Swagger/ui")] HttpRequestMessage req,
        [SwashBuckleClient]ISwashBuckleClient swashBuckleClient)
    {
        return Task.FromResult(swashBuckleClient.CreateSwaggerUIResponse(req, "swagger/json"));
    }
}
  1. Open Swagger UI URL in your browser.

If you does not changed api route prefix. Swagger UI URL is https://hostname/api/swagger/ui .

Options

Include Xml document file

AzureFunctions.Extensions.Swashbuckle can include xml document file.

  1. Change your functions project's GenerateDocumentationFile option to enable.

  2. Add configration setting this extensions on your functions project's hots.json

{
  "version": "2.0",
  "extensions": {
    "Swashbuckle": {
      "XmlPath":  "{your document xml file name}" 
    } 
  }
}
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  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. 
.NET Core netcoreapp3.1 is compatible. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on AzureExtensions.Swashbuckle:

Package Downloads
Service.Extensions.Functions

Extensions to provide consistent configurations and patterns for your service.

Nebularium.Cthulhu.Swagger

Biblioteca para utilização em projetos Azure Functions expond uri do swagger.

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on AzureExtensions.Swashbuckle:

Repository Stars
Azure-Samples/saga-orchestration-serverless
An orchestration-based saga implementation reference in a serverless architecture
Version Downloads Last updated
4.0.4 20,311 8/28/2024
4.0.3 36,705 5/24/2024
4.0.2 7,586 5/15/2024
4.0.1 5,855 5/2/2024
4.0.0-beta 80 5/1/2024
3.3.2 1,715,724 3/24/2021
3.3.1-beta 9,659 2/2/2021
3.3.0-beta 7,898 12/8/2020
3.2.2 660,504 6/17/2020
3.2.1-beta 1,246 6/9/2020
3.2.0-beta 1,318 6/4/2020
3.1.6 85,921 5/10/2020
3.1.5-beta 1,190 5/3/2020
3.1.2-beta 7,620 4/14/2020
3.1.1-beta 873 4/13/2020
3.1.0-beta 863 4/13/2020
3.0.2 91,368 2/29/2020
3.0.1 1,403 2/29/2020
3.0.0 6,520 2/24/2020
2.0.2 1,177 2/24/2020
2.0.1 3,880 12/28/2019
2.0.0 1,460 12/28/2019