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.
Sample
https://github.com/yuka1984/azure-functions-extensions-swashbuckle/tree/master/sample
Update
Version 1.4.4
bug fix
https://github.com/yuka1984/azure-functions-extensions-swashbuckle/issues/20
https://github.com/yuka1984/azure-functions-extensions-swashbuckle/issues/13
breaking changes
https://github.com/yuka1984/azure-functions-extensions-swashbuckle/issues/9
QueryStringParamaterAttribute -> QueryStringParameterAttribute
features
https://github.com/yuka1984/azure-functions-extensions-swashbuckle/pull/18
Thank you @LockTar
Getting Started
- Install the standard Nuget package into your Azure Functions application.
Package Manager : Install-Package AzureFunctions.Extensions.Swashbuckle
CLI : dotnet add package AzureFunctions.Extensions.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());
}
}
}- 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.
-
Add configration setting this extensions on your functions project's hots.json
{
"version": "2.0",
"extensions": {
"Swashbuckle": {
"XmlPath": "{your document xml file name}"
}
}
}
