e47a652261
|
||
|---|---|---|
| .github/workflows | ||
| .vscode | ||
| builds | ||
| docs | ||
| images | ||
| release-notes | ||
| samples | ||
| src | ||
| templates | ||
| test | ||
| .editorconfig | ||
| .gitignore | ||
| CODE_OF_CONDUCT.md | ||
| LICENSE | ||
| Microsoft.Azure.WebJobs.Extensions.OpenApi.sln | ||
| README.md | ||
| SECURITY.md | ||
| Settings.StyleCop | ||
README.md
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 (Preview): 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. It's currently in preview.
- 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 andswagger.jsondocument URL, usingproxies.json.
Sample Azure Function Apps with OpenAPI Metadata Enabled
- Function App v1 proxy
- Function App v2 static
- Function App v2 IoC
- Function App v3 static
- Function App v3 IoC
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.
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.