REQ-14868 - Support for custom template engine helpers
===============================================================================================
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>classes -
The 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:
- Descriptions may not be properly generated for some TypeScript models. This is solvable a template modification but due to what appears to be a bug in OAG the solution requires more logic than the built-in helpers provide. 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
- Helpers using imports not in the classpath will fail. While a more complete solution is most likely possible, I believe the feature has good value regardless.
- [x] Includes unit tests
- [x] Includes code documentation
- [x] Compiled project and tested via
openapi-generator-cli - [x] Squash required
Closes #14868
PR checklist
- [x] Read the contribution guidelines.
- [x] Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
- [x] Run the following to build the project and update samples:
(For Windows users, please run the script in Git BASH) 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./mvnw clean package ./bin/generate-samples.sh ./bin/configs/*.yaml ./bin/utils/export_docs_generators.sh./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. - [x] File the PR against the correct branch:
master(upcoming 7.1.0 minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks) - [x] If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.