Repository files navigation

Project containingMustache-templates used byopenapi-generator-maven-plugin to generateJava Records fromOpenAPI Specifications.

This project contains themustache templates.

Starting with project version2.0.0, the project is licensed under theApache License 2.0.

If you find this project useful, please ⭐Star ⭐ it and share it with others!This is the best way to show appreciation for this project - Thank you! ❤️

If you have feedback or suggestions, please share it in eitherDiscussions orIssues!

The mustache templates are best acquired by importing the project as a dependency.

<dependency>    <groupId>io.github.chrimle</groupId>    <artifactId>openapi-to-java-records-mustache-templates</artifactId>    <version>3.1.2</version></dependency>

It isstrongly recommended to import the project as a dependency. It has officially been published to:

• Maven Central Repository
• GitHub Packages

Place the file(s) in desired directory. Then, in the Maven build configuration, set the property<templateDirectory> to the directory path. Example:

<build>  <plugins>    <plugin>      <groupId>org.openapitools</groupId>      <artifactId>openapi-generator-maven-plugin</artifactId>      <executions>        <execution>          <goals>            <goal>generate</goal>          </goals>          <configuration>            <inputSpec><!-- Relative directory path to the openapi.yaml file--></inputSpec>            <templateDirectory><!-- Relative directory path to the mustache templates--></templateDirectory>            <output><!-- Relative directory path to where generated classes should be placed--></output>          </configuration>        </execution>      </executions>    </plugin>  </plugins></build>

The generated classes are customizable by using<configuration>-properties.

In this example, each generated class field will be annotated withJakarta Bean Validation annotations.

  <configuration><!-- ... more configurations ...-->    <configOptions>      <useBeanValidation>true</useBeanValidation><!-- ... more configOptions ...-->    </configOptions>  </configuration>

components:schemas:Name:description:Name Informationtype:objectrequired:        -firstName        -lastNameproperties:firstName:description:First Nametype:stringminLength:2lastName:description:Last Nametype:stringminLength:2middleName:description:Middle Nametype:stringnullable:truePerson:description:Personal informationdeprecated:truetype:objectrequired:        -name        -age        -gender        -height        -ssn        -aliases        -email        -trackingCode        -uuidproperties:name:description:Nametype:object$ref:'#/components/schemas/Name'age:description:Age (years)type:integerminimum:0maximum:100gender:description:Gendertype:stringenum:            -Male            -Femaleheight:description:Height (m)type:numberpattern:floatminimum:0legalGuardian:description:Legal Guardiantype:object$ref:'#/components/schemas/Person'ssn:description:Social Security Numbertype:stringpattern:'^\d{3}-\d{2}-\d{4}$'aliases:description:Known Aliasestype:arrayuniqueItems:trueminItems:1maxItems:3items:type:stringtelephoneNumber:description:Telephone Numbertype:stringnullable:trueemail:description:Email Addresstype:stringformat:emailtrackingCode:description:Tracking code for Web analyticstype:stringminLength:5maxLength:50default:"utm_source=default"uuid:description:An Universally Unique Identifiertype:stringformat:uuid

Compile the project, for example via:

mvn compile

Unless the configuration property<output> has been set, the generated classes should be found under./target/generated-sources/openapi.

packageio.github.chrimle.o2jrm;/** * Personal information * * @deprecated * @param name Name. * @param age Age (years) * @param gender Gender * @param height Height (m) * @param legalGuardian Person. * @param ssn Social Security Number * @param aliases Known Aliases * @param telephoneNumber Telephone Number * @param email Email Address * @param trackingCode Tracking code for Web analytics * @param uuid An Universally Unique Identifier */@DeprecatedpublicrecordPerson(@Valid@NotNullNamename,@NotNull@Min(0)@Max(100)Integerage,@NotNullGenderEnumgender,@NotNull@DecimalMin("0")BigDecimalheight,@ValidPersonlegalGuardian,@NotNull@Pattern(regexp ="^\\d{3}-\\d{2}-\\d{4}$")Stringssn,@NotNull@Size(min =1,max =3)Set<String>aliases,StringtelephoneNumber,@NotNull@EmailStringemail,@NotNull@Size(min =5,max =50)StringtrackingCode,@NotNullUUIDuuid) {publicPerson(finalNamename,finalIntegerage,finalGenderEnumgender,finalBigDecimalheight,finalPersonlegalGuardian,finalStringssn,finalSet<String>aliases,finalStringtelephoneNumber,finalStringemail,finalStringtrackingCode,finalUUIDuuid) {this.name =name;this.age =age;this.gender =gender;this.height =height;this.legalGuardian =legalGuardian;this.ssn =ssn;this.aliases =Objects.requireNonNullElseGet(aliases, () ->newLinkedHashSet<>());this.telephoneNumber =telephoneNumber;this.email =email;this.trackingCode =Objects.requireNonNullElse(trackingCode,"utm_source=default");this.uuid =uuid;  }/**   * Gender   */publicenumGenderEnum {MALE("Male"),FEMALE("Female");privatefinalStringvalue;GenderEnum(finalStringvalue) {this.value =value;    }/**     * Gets the {@code value} of this enum.     *     * @return the value of this enum.     */publicStringgetValue() {returnvalue;    }/**     * Case-sensitively matches the given {@code value} to an enum constant using {@link     * #getValue()}.     *     * <p><b>NOTE:</b> if multiple enum constants have a matching value, the first enum constant is     * returned, by the order they are declared.     *     * @param value of the enum.     * @return a {@link GenderEnum } with the matching value.     * @throws IllegalArgumentException if no enum has a value matching the given value.     */publicstaticGenderEnumfromValue(finalStringvalue) {for (finalGenderEnumconstant :GenderEnum.values()) {if (constant.getValue().equals(value)) {returnconstant;        }      }thrownewIllegalArgumentException("Unexpected value '" +value +"'");    }  }}

Refer to the test-cases for generated classes, as these list supported plugin<configuration>-options and OpenAPISpecification-properties. The unit-tests could clarify expected behaviors, and the OpenAPI Specification could alsoprovide concrete examples and use-cases. For reference:

• OpenAPI Specification
  Used as the input schema to generateall classes used in testing.
• Maven plugin executions
  Generates classes from the OpenAPI spec, with differentopenapi-generator-maven-plugin configuration options. Theresulting classes are placed in sub-packages, named after the plugin-execution.
• Generated classes
  The resulting classes are organized into sub-packages, which facilitates testing. These files are -albeit in no waynecessary - tracked and versioned in order to be accessible without needing to compile anything. Furthermore, itmakes it easier to spot differences in generated classes after making a change to the mustache templates.
• Test Suite
  Contains all test-cases for generatedrecord andenum classes. These tests areparameterized, to testallclasses in the OpenAPI Specification in combination withall plugin-executions.

Firstly, make a minimal reproducible example - it will greatly facilitate troubleshooting!

Please, verify these stepswithout custom mustache-template files:

1. Verify that the Maven Build Configuration is correct.
2. Verify that the OpenAPI Specification is valid.
3. Verify that classes are generated successfully.
4. Verify that needed dependencies are imported.

Once verified, use the custom mustache-template files and verify the following:

1. Verify that theopenapi-generator-maven-plugin configuration options are supported. SeeSupported 'openapi‐generator‐maven‐plugin' Configuration options.
   • If no configuration options are set, please proceed to the next step.
   • If the configuration option is not listed as supported - please request it viaopen an issue.
2. Verify that the OpenAPI Specification properties are supported. SeeSupported OpenAPI Specification properties.
   • If the property is not listed as supported - please request it viaopen an issue.
3. Compareopenapi-generator-maven-plugin versions
   • As a last resort, it could be due to using an older/newer version than what is used within this project for testing.Even if this would solve the issue - please report it viaopen an issue.

If problems persist, check theopen issues.If the problem you are facing has not already been reported, pleaseopen an issue with details and instructions to reproduce.

• Maven in 5 minutes
• OpenAPI Basic Structure
• openapi-generator-maven-plugin
• Mustache

                             Apache License                       Version 2.0, January 2004                    http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

   "License" shall mean the terms and conditions for use, reproduction,and distribution as defined by Sections 1 through 9 of this document.

   "Licensor" shall mean the copyright owner or entity authorized bythe copyright owner that is granting the License.

   "Legal Entity" shall mean the union of the acting entity and allother entities that control, are controlled by, or are under commoncontrol with that entity. For the purposes of this definition,"control" means (i) the power, direct or indirect, to cause thedirection or management of such entity, whether by contract orotherwise, or (ii) ownership of fifty percent (50%) or more of theoutstanding shares, or (iii) beneficial ownership of such entity.

   "You" (or "Your") shall mean an individual or Legal Entityexercising permissions granted by this License.

   "Source" form shall mean the preferred form for making modifications,including but not limited to software source code, documentationsource, and configuration files.

   "Object" form shall mean any form resulting from mechanicaltransformation or translation of a Source form, including butnot limited to compiled object code, generated documentation,and conversions to other media types.

   "Work" shall mean the work of authorship, whether in Source orObject form, made available under the License, as indicated by acopyright notice that is included in or attached to the work(an example is provided in the Appendix below).

   "Derivative Works" shall mean any work, whether in Source or Objectform, that is based on (or derived from) the Work and for which theeditorial revisions, annotations, elaborations, or other modificationsrepresent, as a whole, an original work of authorship. For the purposesof this License, Derivative Works shall not include works that remainseparable from, or merely link (or bind by name) to the interfaces of,the Work and Derivative Works thereof.

   "Contribution" shall mean any work of authorship, includingthe original version of the Work and any modifications or additionsto that Work or Derivative Works thereof, that is intentionallysubmitted to Licensor for inclusion in the Work by the copyright owneror by an individual or Legal Entity authorized to submit on behalf ofthe copyright owner. For the purposes of this definition, "submitted"means any form of electronic, verbal, or written communication sentto the Licensor or its representatives, including but not limited tocommunication on electronic mailing lists, source code control systems,and issue tracking systems that are managed by, or on behalf of, theLicensor for the purpose of discussing and improving the Work, butexcluding communication that is conspicuously marked or otherwisedesignated in writing by the copyright owner as "Not a Contribution."

   "Contributor" shall mean Licensor and any individual or Legal Entityon behalf of whom a Contribution has been received by Licensor andsubsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions ofthis License, each Contributor hereby grants to You a perpetual,worldwide, non-exclusive, no-charge, royalty-free, irrevocablecopyright license to reproduce, prepare Derivative Works of,publicly display, publicly perform, sublicense, and distribute theWork and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions ofthis License, each Contributor hereby grants to You a perpetual,worldwide, non-exclusive, no-charge, royalty-free, irrevocable(except as stated in this section) patent license to make, have made,use, offer to sell, sell, import, and otherwise transfer the Work,where such license applies only to those patent claims licensableby such Contributor that are necessarily infringed by theirContribution(s) alone or by combination of their Contribution(s)with the Work to which such Contribution(s) was submitted. If Youinstitute patent litigation against any entity (including across-claim or counterclaim in a lawsuit) alleging that the Workor a Contribution incorporated within the Work constitutes director contributory patent infringement, then any patent licensesgranted to You under this License for that Work shall terminateas of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of theWork or Derivative Works thereof in any medium, with or withoutmodifications, and in Source or Object form, provided that Youmeet the following conditions:

   (a) You must give any other recipients of the Work orDerivative Works a copy of this License; and

   (b) You must cause any modified files to carry prominent noticesstating that You changed the files; and

   (c) You must retain, in the Source form of any Derivative Worksthat You distribute, all copyright, patent, trademark, andattribution notices from the Source form of the Work,excluding those notices that do not pertain to any part ofthe Derivative Works; and

   (d) If the Work includes a "NOTICE" text file as part of itsdistribution, then any Derivative Works that You distribute mustinclude a readable copy of the attribution notices containedwithin such NOTICE file, excluding those notices that do notpertain to any part of the Derivative Works, in at least oneof the following places: within a NOTICE text file distributedas part of the Derivative Works; within the Source form ordocumentation, if provided along with the Derivative Works; or,within a display generated by the Derivative Works, if andwherever such third-party notices normally appear. The contentsof the NOTICE file are for informational purposes only anddo not modify the License. You may add Your own attributionnotices within Derivative Works that You distribute, alongsideor as an addendum to the NOTICE text from the Work, providedthat such additional attribution notices cannot be construedas modifying the License.

   You may add Your own copyright statement to Your modifications andmay provide additional or different license terms and conditionsfor use, reproduction, or distribution of Your modifications, orfor any such Derivative Works as a whole, provided Your use,reproduction, and distribution of the Work otherwise complies withthe conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,any Contribution intentionally submitted for inclusion in the Workby You to the Licensor shall be under the terms and conditions ofthis License, without any additional terms or conditions.Notwithstanding the above, nothing herein shall supersede or modifythe terms of any separate license agreement you may have executedwith Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the tradenames, trademarks, service marks, or product names of the Licensor,except as required for reasonable and customary use in describing theorigin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law oragreed to in writing, Licensor provides the Work (and eachContributor provides its Contributions) on an "AS IS" BASIS,WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express orimplied, including, without limitation, any warranties or conditionsof TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR APARTICULAR PURPOSE. You are solely responsible for determining theappropriateness of using or redistributing the Work and assume anyrisks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,whether in tort (including negligence), contract, or otherwise,unless required by applicable law (such as deliberate and grosslynegligent acts) or agreed to in writing, shall any Contributor beliable to You for damages, including any direct, indirect, special,incidental, or consequential damages of any character arising as aresult of this License or out of the use or inability to use theWork (including but not limited to damages for loss of goodwill,work stoppage, computer failure or malfunction, or any and allother commercial damages or losses), even if such Contributorhas been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributingthe Work or Derivative Works thereof, You may choose to offer,and charge a fee for, acceptance of support, warranty, indemnity,or other liability obligations and/or rights consistent with thisLicense. However, in accepting such obligations, You may act onlyon Your own behalf and on Your sole responsibility, not on behalfof any other Contributor, and only if You agree to indemnify,defend, and hold each Contributor harmless for any liabilityincurred by, or claims asserted against, such Contributor by reasonof your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

  To apply the Apache License to your work, attach the following  boilerplate notice, with the fields enclosed by brackets "[]"  replaced with your own identifying information. (Don't include  the brackets!)  The text should be enclosed in the appropriate  comment syntax for the file format. We also recommend that a  file or class name and description of purpose be included on the  same "printed page" as the copyright notice for easier  identification within third-party archives.

Copyright 2024-2025 Chrimle

Licensed under the Apache License, Version 2.0 (the "License");you may not use this file except in compliance with the License.You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, softwaredistributed under the License is distributed on an "AS IS" BASIS,WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.See the License for the specific language governing permissions andlimitations under the License.