Azure Functions OpenAPI Extension

Acknowledgement

• Swagger UI version used for this library is v3.44.0 under the Apache 2.0 license.

Getting Started

• Enable OpenAPI documents to your Azure Functions HTTP Trigger: This document shows how to enable OpenAPI extension on your Azure Functions applications and render Swagger UI, and OpenAPI v2 and v3 documents on-the-fly.
  • Microsoft.Azure.Functions.Worker.Extensions.OpenApi
  • Microsoft.Azure.WebJobs.Extensions.OpenApi
  • Microsoft.Azure.WebJobs.Extensions.OpenApi.Core
• Azure Functions v1 Support: This document shows how to support Azure Functions v1 runtime with this OpenAPI extension.
• Integrating OpenAPI-enabled Azure Functions to Azure API Management: This document shows how to integrate the Azure Functions application with Azure API Management, via this OpenAPI extension.

• Shortening Swagger UI Page URL with proxies.json: This document shows how to shorten both Swagger UI page URL and swagger.json document URL, using proxies.json.

Sample Azure Function Apps with OpenAPI Document Enabled

Here are sample apps using the project references:

• Function App v1 proxy
• Function App v2 static
• Function App v2 IoC
• Function App v3 static
• Function App v3 IoC
• Function App v3 .NET 5

Here are the other sample apps directly using the NuGet packages (external repository):

• Function App v3 with IoC Container
• Function App v3 with Static
• Function App .NET 5 with IoC Container
• Function App .NET 5 with Static
• Function App .NET 6 with IoC Container (in-proc)
• Function App .NET 6 with Static (in-proc)
• Function App .NET 6 with IoC Container (out-of-proc)
• Function App .NET 6 with Static (out-of-proc)

Azure Functions V1 Support

This library supports Azure Functions V2 and onwards. If you still want to get your v1 app supported, find the community contribution or the proxy feature.

Known Issues

Missing .dll Files

Due to the Azure Functions Runtime limitation, sometimes some of .dll files are removed while publishing the function app. In this case, try the following workaround with your function app .csproj file.

<Project Sdk="Microsoft.NET.Sdk">
  ...
  <PropertyGroup>
    ...
    <_FunctionsSkipCleanOutput>true</_FunctionsSkipCleanOutput>
  </PropertyGroup>
  ...
</Project>

Empty Swagger UI When Deployed through Azure Pipelines

• Workaround: #306

Swagger UI Error When Empty Project Referenced

• Workaround: #302

Issues?

While using this library, if you find any issue, please raise an issue on the Issue page.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.