NuGet · #2142 most downloaded on NuGet

Microsoft.Azure.Functions.Worker.Extensions.OpenApi

1.6.016M downloads/moAzure/azure-functions-openapi-extension ↗New releases in your daily digest, changelog included.

This package helps render OpenAPI document and Swagger UI of Azure Functions endpoints through the out-of-process worker.

Last release 1 years ago
02 Oct 2025
Ships unpredictably
gaps range from 2 weeks to 2.7 years
Most releases are documented
notes for 7 of 8 stable releases
Nothing withdrawn
no release was ever pulled
5 years old
12 releases · first in 2021

Release timeline

12 releases since 2021

20212022

Releases

2.0.0-preview227 Jan 2023pre-release
No changes or fixes other than v1.5.1
Release Notes

Including v1.5.1

Breaking Changes

No breaking changes

Changes & Fixes

No changes or fixes other than v1.5.1

What's Changed

Update sample app that applies v1.5.0 by Justin Yoo (@justinyoo) in #528

add TimeSpanObjectTypeVisitor by sinantutan (@sinantutan) in #524

Allow object types to be marked as nullable by Mulalo Mufamadi (@lalo3k) in #504

Fix issue with DocumentHelperExceptions.GetOpenApiParameters not forwarding the OpenAPI schema version. by jstoker (@jstoker) in #503

Fix handling of 'Required' fields for Newtonsoft by William-Froelich in #506

Flexibility to choose Microsoft.AspNetcore.App on the isolate worker by Justin Yoo (@justinyoo) in #547

New Contributors

sinantutan (@sinantutan) made their first contribution in #524

Mulalo Mufamadi (@lalo3k) made their first contribution in #504

jstoker (@jstoker) made their first contribution in #503

William-Froelich made their first contribution in #506

Full Changelog: v2.0.0-preview1...v2.0.0-preview2

From the same repository

Azure/azure-functions-openapi-extension

2.0.0-preview123 Dec 2022pre-release

OpenApiHttpTriggerAuthorization has now been included to OpenApiConfigurationOptions .

Release Notes

Including v1.5.0

Breaking Changes

OpenApiHttpTriggerAuthorization has now been included to OpenApiConfigurationOptions.
OpenApiConfigurationOptions.IncludeRequestingHostName has now been changed to OpenApiConfigurationOptions.ExcludeRequestingHost.

Changes & Fixes

#526 Update OpenApiSettings
#477 V2/ Merge OpenApiHttpTriggerAuthorization with OpenApiConfigurationOptions
#397 Change IncludeRequestingHostName to ExcludeRequestingHost #393 #390

Open source →

1.5.127 Jan 2023

Update sample app that applies v1.5.0 by Justin Yoo (@justinyoo) in #528

Release Notes

Bug fixes and enhancements

Changes & Fixes

#547 Flexibility to choose Microsoft.AspNetcore.App on the isolate worker #536 #534
#524 add TimeSpanObjectTypeVisitor #401
#506 Fix handling of 'Required' fields for Newtonsoft #402 #336
#504 Allow object types to be marked as nullable
#503 Fix issue with DocumentHelperExceptions.GetOpenApiParameters not forwarding the OpenAPI schema version

What's Changed

Update sample app that applies v1.5.0 by Justin Yoo (@justinyoo) in #528
add TimeSpanObjectTypeVisitor by sinantutan (@sinantutan) in #524
Allow object types to be marked as nullable by Mulalo Mufamadi (@lalo3k) in #504
Fix issue with DocumentHelperExceptions.GetOpenApiParameters not forwarding the OpenAPI schema version. by jstoker (@jstoker) in #503
Fix handling of 'Required' fields for Newtonsoft by William-Froelich in #506
Flexibility to choose Microsoft.AspNetcore.App on the isolate worker by Justin Yoo (@justinyoo) in #547

New Contributors

sinantutan (@sinantutan) made their first contribution in #524
Mulalo Mufamadi (@lalo3k) made their first contribution in #504
jstoker (@jstoker) made their first contribution in #503
William-Froelich made their first contribution in #506

Full Changelog: v1...v1.5.1

Open source →

1.5.023 Dec 2022

.NET 7 support for out-of-proc worker

Release Notes

.NET 7 support for out-of-proc worker
OpenAPI settings from environment variables injected out-of-the-box
More authN scenarios including Azure EasyAuth is now possible
GitHub Actions to generate OpenAPI documents within the CI/CD pipeline
Both PowerShell and bash shell script are available for generic CI/CD pipelines other than GitHub Actions
DevContainer support including GitHub Codespaces

Changes & Fixes

#525 Add built-in OpenAPI app settings object
#523 Add implicit DI feature for out-of-proc worker
#522 .NET 7 support for out-of-process worker
#500 Add doc for authN scenarios #481
#498 Add OpenAPI document generation scripts - .ps1 and .sh #496 #492
#497 Add devcontainer settings Support
#494 Fix typo from Wroker to Worker
#489 GitHub Actions to generate OpenAPI document from the code #369 #366 #343 #342 #337 #314 #305 #304 #303 #283 #249 #73 #58
#483 Make OpenApiCustomUIOptions Injectable #478

What's Changed

.NET 7 support for out-of-process worker by Justin Yoo (@justinyoo) in #522
Add implicit DI feature for out-of-proc worker by Justin Yoo (@justinyoo) in #523
Add built-in OpenAPI app settings object by Justin Yoo (@justinyoo) in #525

Full Changelog: v1...v1.5.0

Open source →

1.4.023 Aug 2022

Add Task #3 Test Code by Devist (@CistusF) in #412

Release Notes

Bug fixes and enhancements

Changes & Fixes

#476 Add delegate OpenApiHttpTriggerAuthorization to be more configurable #458 #434
#466 More DI feature for OpenApiConfigurationOptions #458 #430
#464 Update the version of NuGet packages for test projects
#463 Add more test cases for OpenApiHttpTriggerContext
#435 Support dynamic OpenApiHttpTriggerAuthorization #458 #434
#432 Support dynamic OpenApiConfigurationOptions #458 #430
#429 Fix null reference exception
#426 Distinct same types
#424 Only add unique openApiReferenceIds to the exported types #407
#415 Fixed invalid urls when include whitespace in "OpenApi__HostNames" option #411
#385 Fix: OAuth redirect url is invalid #384

What's Changed

Add Task #3 Test Code by Devist (@CistusF) in #412
Check Open Api version by Sersoc in #414
OpenApiDocument HostNames Test by kafkaaaa in #413
Fix: OAuth redirect url is invalid by Derich367 in #385
Fixed invalid urls when include whitespace in "OpenApi__HostNames" option. by Gusam Park (@level120) in #415
Update vscode task to build and run samples by Ahmad Tantowi (@ahmadtantowi) in #420
Only add unique openApiReferenceIds to the exported types by Arjan321 in #424
Distinct same types by xDDDx in #426
Adds new function for OpenApi v3 by Geon-Hyeong Park (@GEONheong) in #441
add DocumentTests by @did7121 in #442
Fix null reference exception by Aleksey Perhunov (BE-apply) (@im-aperkhunov) in #429
Add more test cases for OpenApiHttpTriggerContext by Justin Yoo (@justinyoo) in #463
Update the version of NuGet packages for test projects by Justin Yoo (@justinyoo) in #464
Support dynamic OpenApiConfigurationOptions by Jack Batzner (@jackbatzner) in #432
More DI feature for OpenApiConfigurationOptions by Justin Yoo (@justinyoo) in #466
Support dynamic OpenApiHttpTriggerAuthorization by Jack Batzner (@jackbatzner) in #435
Add delegate OpenApiHttpTriggerAuthorization to be more configurable by Justin Yoo (@justinyoo) in #476

New Contributors

Devist (@CistusF) made their first contribution in #412
Sersoc made their first contribution in #414
kafkaaaa made their first contribution in #413
Ahmad Tantowi (@ahmadtantowi) made their first contribution in #420
Arjan321 made their first contribution in #424
xDDDx made their first contribution in #426
Geon-Hyeong Park (@GEONheong) made their first contribution in #441
@did7121 made their first contribution in #442
Aleksey Perhunov (BE-apply) (@im-aperkhunov) made their first contribution in #429
Jack Batzner (@jackbatzner) made their first contribution in #432

Full Changelog: v1.3.0...v1.4.0

Open source →

1.3.028 Mar 2022Breaking

Although it was unintentional, a breaking change has been introduced to this release, which was overlooked.

Release Notes

Bug fixes and enhancements

Breaking Changes

Although it was unintentional, a breaking change has been introduced to this release, which was overlooked.

#344 Allow IDocument to be modified before rendering #376 #340

Changes & Fixes

#395 Update GetTypesFromReferencedFunctionApps #387 #377
#392 Update properties to be virtual on DefaultOpenApiConfigurationOptions #391
#388 Lenght => Length
#383 Funktion key from config gets overwritten by function key in url #382
#381 Ignore failure during assembly loading #377 #373

New Contributors

Thomas Bleijendaal (@ThomasBleijendaal) made their first contribution in #344
Derich367 made their first contribution in #381

Full Changelog: v1.2.0...v1.3.0

Open source →

1.2.025 Feb 2022

Release Notes Bug fixes and enhancements Changes & Fixes #362 Do not consider abstract classes in configuration options #368 Update logic for isolated

Release Notes

Bug fixes and enhancements

Changes & Fixes

#362 Do not consider abstract classes in configuration options
#368 Update logic for isolated worker #365
#367 multipart/form-data in OpenAPI v2 Rendering Workaround (Interim) #365
#364 Fix RecursiveObjectTypeVisitor to filter duplicated field names #356
#361 Add method to load types from referenced function app #351 #132

Full Changelog: v1.1.0...v1.2.0

Open source →

1.1.011 Feb 2022

The out-of-proc worker extension now explicitly targets both .NET 5 and 6.

Release Notes

Bug fixes and enhancements

The out-of-proc worker extension now explicitly targets both .NET 5 and 6.

Changes & Fixes

#358 Refactor sample apps for .NET 6 in-proc/out-of-proc
#330 Allow relative URL being used as base URL
#329 Deprecated feature implementation #319
#318 Resolve TypeLoadException for QueryCollection #296
#311 Support Required attribute #226
#310 Fixes: Enum of type byte is ignored #309
#301 Fix: OpenAPI attributes are not getting picked up if they are in a referenced class library project #298
#297 Add a HideDocument flag akin to HideSwaggerUI

New Contributors 🎉🎉🎉

ljhyeon made their first contribution in #324
이승민 Seung Min Lee (@miloul) made their first contribution in #323
LEE JIAN (@lee-ji-an) made their first contribution in #325
Danny van der Sluijs (@DannyvdSluijs) made their first contribution in #338
Lennart van Koot (@LennartKoot) made their first contribution in #311
Yifan Bian (@yifanbian-msft) made their first contribution in #330
Panos Kousidis (@PanosKousidis) made their first contribution in #301
Dr Aieat Assam (@AieatAssam) made their first contribution in #318
gsteenpa made their first contribution in #297

Full Changelog: v1.0.0...v1.1.0

Open source →