AzureExtensions.Swashbuckle
3.3.0-beta
See the version list below for details.
dotnet add package AzureExtensions.Swashbuckle --version 3.3.0-beta
NuGet\Install-Package AzureExtensions.Swashbuckle -Version 3.3.0-beta
<PackageReference Include="AzureExtensions.Swashbuckle" Version="3.3.0-beta" />
paket add AzureExtensions.Swashbuckle --version 3.3.0-beta
#r "nuget: AzureExtensions.Swashbuckle, 3.3.0-beta"
// Install AzureExtensions.Swashbuckle as a Cake Addin #addin nuget:?package=AzureExtensions.Swashbuckle&version=3.3.0-beta&prerelease // Install AzureExtensions.Swashbuckle as a Cake Tool #tool nuget:?package=AzureExtensions.Swashbuckle&version=3.3.0-beta&prerelease
AzureExtensions.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.3.0
https://www.nuget.org/packages/AzureExtensions.Swashbuckle/3.3.0-beta
- Fixed several issues, related to versioning and XML comments.
- Updated to UI v3.37.2
- Updated to Swagger 5.6.3
- Updated documentation
- Ability to create multiple versions of documents, example added.
- Added examples of a custom filter, improved test application
3.1.6
https://www.nuget.org/packages/AzureExtensions.Swashbuckle/3.1.6
Fixed #8, #9
Updated to UI v3.25.1
Updated to Swagger 5.4.1
Fixed base url for Swagger UI
Breaking:
Option and DocumentOption renamed to SwaggerDocOptions and SwaggerDocument respectivly and moved to AzureFunctions.Extensions.Swashbuckle.Settings namespace
Properties renamed:
PrepandOperationWithRoutePrefix ⇒ PrependOperationWithRoutePrefix
AddCodeParamater ⇒ AddCodeParameter
Properties added:
Added ability to configure SwaggerGen via ConfigureSwaggerGen
Added ability to override default url to Swagger json document (in case of reverse proxy/gateway/ingress) are used.
Size:
All the resources are places in zip archive in order to decrease result dll size by 338% (from 1.594kb to 472kb)
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
Update
Version 3.0.0
Getting Started
- Install the standard Nuget package into your Azure Functions application.
Package Manager : Install-Package AzureExtensions.Swashbuckle
CLI : dotnet add package AzureExtensions.Swashbuckle
- 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());
}
}
}
or you can create a more defailed configuration like this:
public void Configure(IWebJobsBuilder builder)
{
//Register the extension
builder.AddSwashBuckle(Assembly.GetExecutingAssembly(), opts =>
{
opts.SpecVersion = OpenApiSpecVersion.OpenApi2_0;
opts.AddCodeParameter = true;
opts.PrependOperationWithRoutePrefix = true;
opts.Documents = new []
{
new SwaggerDocument
{
Name = "v1",
Title = "Swagger document",
Description = "Swagger test document",
Version = "v2"
}
};
opts.Title = "Swagger Test";
//opts.OverridenPathToSwaggerJson = new Uri("http://localhost:7071/api/Swagger/json");
opts.ConfigureSwaggerGen = (x =>
{
x.CustomOperationIds(apiDesc =>
{
return apiDesc.TryGetMethodInfo(out MethodInfo methodInfo)
? methodInfo.Name
: new Guid().ToString();
});
});
});
}
- 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"));
}
}
- 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.
Change your functions project's GenerateDocumentationFile option to enable.
builder.AddSwashBuckle(Assembly.GetExecutingAssembly(), opts => { opts.XmlPath = "TestFunction.xml"; });
Add configration setting this extensions on your functions project's local.settings.json
"SwaggerDocOptions": {
"XmlPath": "TestFunction.xml"
}
Product | Versions 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. |
-
.NETCoreApp 3.1
- Microsoft.Azure.Functions.Extensions (>= 1.1.0)
- Microsoft.Azure.WebJobs.Extensions.Http (>= 3.0.2)
- Swashbuckle.AspNetCore (>= 5.6.3)
- Swashbuckle.AspNetCore.Swagger (>= 5.6.3)
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 | 36,789 | 8/28/2024 |
4.0.3 | 42,512 | 5/24/2024 |
4.0.2 | 8,812 | 5/15/2024 |
4.0.1 | 6,271 | 5/2/2024 |
4.0.0-beta | 83 | 5/1/2024 |
3.3.2 | 1,745,189 | 3/24/2021 |
3.3.1-beta | 9,663 | 2/2/2021 |
3.3.0-beta | 7,908 | 12/8/2020 |
3.2.2 | 663,289 | 6/17/2020 |
3.2.1-beta | 1,253 | 6/9/2020 |
3.2.0-beta | 1,320 | 6/4/2020 |
3.1.6 | 86,322 | 5/10/2020 |
3.1.5-beta | 1,192 | 5/3/2020 |
3.1.2-beta | 7,622 | 4/14/2020 |
3.1.1-beta | 875 | 4/13/2020 |
3.1.0-beta | 865 | 4/13/2020 |
3.0.2 | 91,608 | 2/29/2020 |
3.0.1 | 1,407 | 2/29/2020 |
3.0.0 | 6,526 | 2/24/2020 |
2.0.2 | 1,185 | 2/24/2020 |
2.0.1 | 3,884 | 12/28/2019 |
2.0.0 | 1,470 | 12/28/2019 |