REQ-14868 - Support for custom template engine helpers#17777
Open
yuval-po wants to merge 4 commits into
Open
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
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.
===============================================================================================
Introduces support for use of custom template helpers via an option to provide a JAR path
===============================================================================================
Overview
Accept a new
additionalPropertieskeytemplatingEngineHelper- a path to a JAR containingMustache.Lambdas or HandlebarsHelper<T>classesThe template engine adapter enumerates the JAR for helpers for the currently selected engine
Helpers are injected into the context on compile (Mustache) or registered on the engine (Handlebars)
Helpers can be invoked in the template via their simple class name (e.g.
{{#SomeHelper}}{{/SomeHelper}})Rationale
Provide support for more complex use-cases involving template logic not covered by built-in helpers
Facilitate a way to 'inject' into the template context. Helper functions can serve as a bridge of sorts between OAG and user code. Some overlap with existing
additionalPropertiesvenue but allows for greater flexibility.Provide a way to mitigate certain issues without waiting for an official release or upgrading
A real world example:
This forces the user to migrate to a fixed version, if available, incurring the usual effort costs or work-around the issue otherwise.
This is especially useful in enterprise or API-proxy scenarios where it may be difficult to upgrade OAG version due to breaking schema changes
Caveats
I believe the feature has good value regardless.
openapi-generator-cliCloses #14868
PR checklist
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*.IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
master(upcoming 7.1.0 minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks)