feat!: Complete rewrite of @apvee/azure-functions-openapi for next-ge… #13
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…neration OpenAPI integration in Azure Functions feat!: Complete rewrite of @apvee/azure-functions-openapi for next-generation OpenAPI integration in Azure Functions This update represents a full architectural redesign of the library, introducing a more modular, extensible, and strongly typed foundation for building OpenAPI-enabled Azure Functions. - Reimplemented the entire OpenAPI registration system with a cleaner, pluggable architecture. - Introduced a centralized OpenAPI registry for managing components, schemas, and security definitions. - Added automatic OpenAPI document generation with first-class Swagger UI integration. - Unified endpoint and webhook handling with consistent route normalization and metadata management. - Introduced typed request/response handlers with automatic type inference and validation via Zod. - Added a comprehensive security module supporting multiple Azure authentication schemes: - Azure AD Bearer Token - Client Credentials - EasyAuth - Azure Function Keys - Custom API Key validation - Implemented new helpers for request/response configuration (`ContentTypeConfig`, `ResponseConfig`). - Enhanced support for multi-content-type responses and webhook transformations. - Added global configuration management and improved Swagger 2.0 backward compatibility. - Reorganized internal module structure for better maintainability and clarity. - Provided extensive developer documentation, examples, and inline JSDoc annotations. - Migrated all core modules (`endpoint`, `docs`, `ui`, `registry`, `schemas`, `security`, `transform`) to an internal architecture. - Simplified imports through a single public API surface in `index.ts`. - Optimized type definitions for deep Azure Functions and OpenAPI integration. - Modernized utility functions and schema conversion logic. - Introduced operationId mapping for webhooks and enhanced metadata propagation. - The entire API surface has been redesigned for consistency and type safety. - Previous function decorators, schema registration APIs, and configuration options have been replaced. - All existing integrations should migrate to the new function and schema registration model.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
…neration OpenAPI integration in Azure Functions
feat!: Complete rewrite of @apvee/azure-functions-openapi for next-generation OpenAPI integration in Azure Functions
This update represents a full architectural redesign of the library, introducing a more modular, extensible, and strongly typed foundation for building OpenAPI-enabled Azure Functions.
Reimplemented the entire OpenAPI registration system with a cleaner, pluggable architecture.
Introduced a centralized OpenAPI registry for managing components, schemas, and security definitions.
Added automatic OpenAPI document generation with first-class Swagger UI integration.
Unified endpoint and webhook handling with consistent route normalization and metadata management.
Introduced typed request/response handlers with automatic type inference and validation via Zod.
Added a comprehensive security module supporting multiple Azure authentication schemes:
Implemented new helpers for request/response configuration (
ContentTypeConfig,ResponseConfig).Enhanced support for multi-content-type responses and webhook transformations.
Added global configuration management and improved Swagger 2.0 backward compatibility.
Reorganized internal module structure for better maintainability and clarity.
Provided extensive developer documentation, examples, and inline JSDoc annotations.
Migrated all core modules (
endpoint,docs,ui,registry,schemas,security,transform) to an internal architecture.Simplified imports through a single public API surface in
index.ts.Optimized type definitions for deep Azure Functions and OpenAPI integration.
Modernized utility functions and schema conversion logic.
Introduced operationId mapping for webhooks and enhanced metadata propagation.
The entire API surface has been redesigned for consistency and type safety.
Previous function decorators, schema registration APIs, and configuration options have been replaced.
All existing integrations should migrate to the new function and schema registration model.