Skip to content


Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?


Failed to load latest commit information.
Latest commit message
Commit time

Azure Functions OpenAPI Extension

Out-of-Proc Worker In-Proc Worker


Getting Started

  • **Generic CI/CD Pipeline Support: This document shows how to generate the OpenAPI document within a CI/CD pipeline, using either PowerShell or bash shell script.

GitHub Actions Support

If you are using GitHub Actions as your preferred CI/CD pipeline, you can run the GitHub Action into your workflow to automatically generate the OpenAPI document. Find more details at the Build OpenAPI action page.

GitHub Codespaces Support

If you want to run your Azure Functions app on GitHub Codespaces, you might want to accommodate local.settings.json. The following PowerShell script may help you for the accommodation:

# Update local.settings.json
pwsh -c "Invoke-RestMethod | Invoke-Expression"

Sample Azure Function Apps with OpenAPI Document Enabled

Here are sample apps using the project references:

## Azure Functions V1 Support ##

This library supports Azure Functions V3 and onwards. If you still want to get your v1 and v2 runtime 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">

Empty Swagger UI When Deployed through Azure Pipelines

Swagger UI Error When Empty Project Referenced


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


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

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 with any additional questions or comments.