From 940a93b6933016a8f25c2a8fa27f669d0c72bf88 Mon Sep 17 00:00:00 2001 From: Ignacio Vidal Date: Wed, 1 Jul 2026 01:02:04 +0100 Subject: [PATCH] [jaxrs-spec] Support useRecords Adds a useRecords option to the jaxrs-spec generator. When useRecords=true, the concrete subtypes that implement a generated oneOf interface render as Java records instead of mutable classes. - JavaJAXRSSpecServerCodegen: useRecords option, and postProcessAllModels marks record-eligible implementors with x-jaxrs-record (no parent, no additional properties, implements a generated oneOf interface). - record.mustache renders the record; model.mustache routes x-jaxrs-record to it. - oneof_interface.mustache declares the discriminator accessor in record style (petType()) under useRecords so records satisfy the interface via their canonical accessors; sealed.mustache no longer marks a record final. - pom.mustache bumps java.version to 17 when useRecords (records need JDK 16+). - Adds testOneOfRecordImplementationGeneration and a jaxrs-spec-records sample (registered in the JDK17 samples workflow). useRecords is independent of useSealed. The feature stays opt-in; default jaxrs-spec output is unchanged. --- .github/workflows/samples-jdk17.yaml | 3 + bin/configs/jaxrs-spec-records.yaml | 11 ++ .../languages/JavaJAXRSSpecServerCodegen.java | 53 ++++++- .../resources/JavaJaxRS/spec/model.mustache | 2 +- .../JavaJaxRS/spec/oneof_interface.mustache | 2 +- .../resources/JavaJaxRS/spec/pom.mustache | 2 +- .../resources/JavaJaxRS/spec/record.mustache | 64 ++++++++ .../resources/JavaJaxRS/spec/sealed.mustache | 2 +- .../jaxrs/JavaJAXRSSpecServerCodegenTest.java | 57 +++++++ .../.openapi-generator-ignore | 23 +++ .../.openapi-generator/FILES | 11 ++ .../.openapi-generator/VERSION | 1 + .../petstore/jaxrs-spec-records/README.md | 27 ++++ .../petstore/jaxrs-spec-records/pom.xml | 149 ++++++++++++++++++ .../java/org/openapitools/api/PetsApi.java | 33 ++++ .../org/openapitools/api/RestApplication.java | 9 ++ .../openapitools/api/RestResourceRoot.java | 5 + .../org/openapitools/model/CatRequest.java | 28 ++++ .../org/openapitools/model/DogRequest.java | 28 ++++ .../java/org/openapitools/model/PetBase.java | 115 ++++++++++++++ .../org/openapitools/model/PetRequest.java | 30 ++++ .../java/org/openapitools/model/PetType.java | 59 +++++++ .../src/main/openapi/openapi.yaml | 78 +++++++++ 23 files changed, 782 insertions(+), 10 deletions(-) create mode 100644 bin/configs/jaxrs-spec-records.yaml create mode 100644 modules/openapi-generator/src/main/resources/JavaJaxRS/spec/record.mustache create mode 100644 samples/server/petstore/jaxrs-spec-records/.openapi-generator-ignore create mode 100644 samples/server/petstore/jaxrs-spec-records/.openapi-generator/FILES create mode 100644 samples/server/petstore/jaxrs-spec-records/.openapi-generator/VERSION create mode 100644 samples/server/petstore/jaxrs-spec-records/README.md create mode 100644 samples/server/petstore/jaxrs-spec-records/pom.xml create mode 100644 samples/server/petstore/jaxrs-spec-records/src/gen/java/org/openapitools/api/PetsApi.java create mode 100644 samples/server/petstore/jaxrs-spec-records/src/gen/java/org/openapitools/api/RestApplication.java create mode 100644 samples/server/petstore/jaxrs-spec-records/src/gen/java/org/openapitools/api/RestResourceRoot.java create mode 100644 samples/server/petstore/jaxrs-spec-records/src/gen/java/org/openapitools/model/CatRequest.java create mode 100644 samples/server/petstore/jaxrs-spec-records/src/gen/java/org/openapitools/model/DogRequest.java create mode 100644 samples/server/petstore/jaxrs-spec-records/src/gen/java/org/openapitools/model/PetBase.java create mode 100644 samples/server/petstore/jaxrs-spec-records/src/gen/java/org/openapitools/model/PetRequest.java create mode 100644 samples/server/petstore/jaxrs-spec-records/src/gen/java/org/openapitools/model/PetType.java create mode 100644 samples/server/petstore/jaxrs-spec-records/src/main/openapi/openapi.yaml diff --git a/.github/workflows/samples-jdk17.yaml b/.github/workflows/samples-jdk17.yaml index e4ea6b9d299c..82d57c817434 100644 --- a/.github/workflows/samples-jdk17.yaml +++ b/.github/workflows/samples-jdk17.yaml @@ -23,6 +23,7 @@ on: - samples/server/petstore/java-helidon-server/v3/mp/** - samples/server/petstore/java-helidon-server/v3/se/** - samples/server/petstore/jaxrs-spec-sealed/** + - samples/server/petstore/jaxrs-spec-records/** pull_request: paths: # clients @@ -46,6 +47,7 @@ on: - samples/server/petstore/java-helidon-server/v3/mp/** - samples/server/petstore/java-helidon-server/v3/se/** - samples/server/petstore/jaxrs-spec-sealed/** + - samples/server/petstore/jaxrs-spec-records/** jobs: build: name: Build with JDK17 @@ -75,6 +77,7 @@ jobs: - samples/server/petstore/java-helidon-server/v3/mp/ - samples/server/petstore/java-helidon-server/v3/se - samples/server/petstore/jaxrs-spec-sealed + - samples/server/petstore/jaxrs-spec-records steps: - uses: actions/checkout@v7 - uses: actions/setup-java@v5 diff --git a/bin/configs/jaxrs-spec-records.yaml b/bin/configs/jaxrs-spec-records.yaml new file mode 100644 index 000000000000..81b72cffee16 --- /dev/null +++ b/bin/configs/jaxrs-spec-records.yaml @@ -0,0 +1,11 @@ +generatorName: jaxrs-spec +outputDir: samples/server/petstore/jaxrs-spec-records +inputSpec: modules/openapi-generator/src/test/resources/3_0/jaxrs-spec/oneof_interface.yaml +templateDir: modules/openapi-generator/src/main/resources/JavaJaxRS/spec +additionalProperties: + artifactId: jaxrs-spec-records-petstore-server + useOneOfInterfaces: "true" + useSealed: "true" + useRecords: "true" + serializableModel: "true" + hideGenerationTimestamp: "true" diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/JavaJAXRSSpecServerCodegen.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/JavaJAXRSSpecServerCodegen.java index a19abc67b903..bd0d9fba7eb0 100644 --- a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/JavaJAXRSSpecServerCodegen.java +++ b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/JavaJAXRSSpecServerCodegen.java @@ -34,8 +34,10 @@ import java.io.File; import java.util.Collection; import java.util.HashMap; +import java.util.HashSet; import java.util.List; import java.util.Map; +import java.util.Set; import static org.openapitools.codegen.languages.features.GzipFeatures.USE_GZIP_FEATURE; @@ -60,6 +62,7 @@ public class JavaJAXRSSpecServerCodegen extends AbstractJavaJAXRSServerCodegen { public static final String USE_JAKARTA_SECURITY_ANNOTATIONS = "useJakartaSecurityAnnotations"; public static final String USE_ENUM_CASE_INSENSITIVE = "useEnumCaseInsensitive"; public static final String USE_SEALED = "useSealed"; + public static final String USE_RECORDS = "useRecords"; public static final String QUARKUS_LIBRARY = "quarkus"; public static final String THORNTAIL_LIBRARY = "thorntail"; @@ -83,6 +86,9 @@ public class JavaJAXRSSpecServerCodegen extends AbstractJavaJAXRSServerCodegen { @Setter protected boolean useSealed = false; + @Setter + protected boolean useRecords = false; + private final JakartaSecurityAnnotationProcessor jakartaSecurityAnnotationProcessor = new JakartaSecurityAnnotationProcessor(); @Getter @Setter @@ -167,6 +173,7 @@ public JavaJAXRSSpecServerCodegen() { cliOptions.add(CliOption.newBoolean(GENERATE_JSON_CREATOR, "Whether to generate @JsonCreator constructor for required properties.", generateJsonCreator)); cliOptions.add(CliOption.newBoolean(USE_ENUM_CASE_INSENSITIVE, "Use `equalsIgnoreCase` when String for enum comparison", useEnumCaseInsensitive)); cliOptions.add(CliOption.newBoolean(USE_SEALED, "Whether to generate sealed model interfaces and classes.", useSealed)); + cliOptions.add(CliOption.newBoolean(USE_RECORDS, "Whether to render the implementations of a generated oneOf interface (useOneOfInterfaces=true) as Java records instead of classes.", useRecords)); } @Override @@ -211,6 +218,7 @@ public void processOpts() { convertPropertyToBooleanAndWriteBack(GENERATE_JSON_CREATOR, this::setGenerateJsonCreator); convertPropertyToBooleanAndWriteBack(USE_ENUM_CASE_INSENSITIVE, this::setUseEnumCaseInsensitive); convertPropertyToBooleanAndWriteBack(USE_SEALED, this::setUseSealed); + convertPropertyToBooleanAndWriteBack(USE_RECORDS, this::setUseRecords); if (additionalProperties.containsKey(OPEN_API_SPEC_FILE_LOCATION)) { openApiSpecFileLocation = additionalProperties.get(OPEN_API_SPEC_FILE_LOCATION).toString(); @@ -400,16 +408,20 @@ public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List postProcessAllModels(Map objs) { Map result = super.postProcessAllModels(objs); - // Index the discriminators of the generated oneOf interfaces by classname. A child of a oneOf - // interface (useOneOfInterfaces) inherits a shared base via allOf and therefore has no Java - // parentModel carrying the discriminator - the discriminator lives on the interface it implements. + // Collect, for the interfaces generated by the useOneOfInterfaces feature: their classnames (to + // identify which concrete models implement one of them and are therefore record candidates) and + // their discriminators indexed by classname (a child of a oneOf interface inherits a shared base + // via allOf and has no Java parentModel carrying the discriminator - it lives on the interface). + Set oneOfInterfaceNames = new HashSet<>(); Map oneOfInterfaceDiscriminators = new HashMap<>(); for (ModelsMap modelsMap : result.values()) { for (ModelMap modelMap : modelsMap.getModels()) { CodegenModel model = modelMap.getModel(); - if (Boolean.TRUE.equals(model.getVendorExtensions().get("x-is-one-of-interface")) - && model.getDiscriminator() != null) { - oneOfInterfaceDiscriminators.put(model.classname, model.getDiscriminator()); + if (Boolean.TRUE.equals(model.getVendorExtensions().get("x-is-one-of-interface"))) { + oneOfInterfaceNames.add(model.classname); + if (model.getDiscriminator() != null) { + oneOfInterfaceDiscriminators.put(model.classname, model.getDiscriminator()); + } } } } @@ -437,6 +449,9 @@ public Map postProcessAllModels(Map objs) if (useSealed && !Boolean.TRUE.equals(model.getVendorExtensions().get("x-is-one-of-interface"))) { model.permits.removeAll(model.oneOf); } + if (useRecords && isOneOfInterfaceRecordCandidate(model, oneOfInterfaceNames)) { + model.getVendorExtensions().put("x-jaxrs-record", true); + } } } return result; @@ -463,6 +478,32 @@ private CodegenDiscriminator discriminatorOfImplementedOneOfInterface( return null; } + /** + * A concrete model is rendered as a record only when it implements a oneOf interface produced by the + * useOneOfInterfaces feature, and it is structurally record-compatible: it has no Java parent (records + * cannot extend) and no additional (undeclared) properties (those require a mutable map-backed pojo). + * + * @param model the concrete model that may implement a oneOf interface + * @param oneOfInterfaceNames the classnames of the generated oneOf interfaces + * @return {@code true} when the model should be rendered as a record + */ + @SuppressWarnings("unchecked") + private boolean isOneOfInterfaceRecordCandidate(CodegenModel model, Set oneOfInterfaceNames) { + if (model.getParent() != null || model.getAdditionalPropertiesType() != null) { + return false; + } + Object implementsExtension = model.getVendorExtensions().get("x-implements"); + if (!(implementsExtension instanceof Collection)) { + return false; + } + for (Object intf : (Collection) implementsExtension) { + if (oneOfInterfaceNames.contains(String.valueOf(intf))) { + return true; + } + } + return false; + } + @Override public CodegenOperation fromOperation(String path, String httpMethod, Operation operation, List servers) { CodegenOperation op = super.fromOperation(path, httpMethod, operation, servers); diff --git a/modules/openapi-generator/src/main/resources/JavaJaxRS/spec/model.mustache b/modules/openapi-generator/src/main/resources/JavaJaxRS/spec/model.mustache index 6060ce15d2ed..89bf0a6e6619 100644 --- a/modules/openapi-generator/src/main/resources/JavaJaxRS/spec/model.mustache +++ b/modules/openapi-generator/src/main/resources/JavaJaxRS/spec/model.mustache @@ -16,6 +16,6 @@ import {{javaxPackage}}.validation.Valid; {{>enumOuterClass}} {{/isEnum}} -{{^isEnum}}{{#vendorExtensions.x-is-one-of-interface}}{{>oneof_interface}}{{/vendorExtensions.x-is-one-of-interface}}{{^vendorExtensions.x-is-one-of-interface}}{{>pojo}}{{/vendorExtensions.x-is-one-of-interface}}{{/isEnum}} +{{^isEnum}}{{#vendorExtensions.x-is-one-of-interface}}{{>oneof_interface}}{{/vendorExtensions.x-is-one-of-interface}}{{^vendorExtensions.x-is-one-of-interface}}{{#vendorExtensions.x-jaxrs-record}}{{>record}}{{/vendorExtensions.x-jaxrs-record}}{{^vendorExtensions.x-jaxrs-record}}{{>pojo}}{{/vendorExtensions.x-jaxrs-record}}{{/vendorExtensions.x-is-one-of-interface}}{{/isEnum}} {{/model}} {{/models}} diff --git a/modules/openapi-generator/src/main/resources/JavaJaxRS/spec/oneof_interface.mustache b/modules/openapi-generator/src/main/resources/JavaJaxRS/spec/oneof_interface.mustache index 34d601b12c5f..9bc84ee88a29 100644 --- a/modules/openapi-generator/src/main/resources/JavaJaxRS/spec/oneof_interface.mustache +++ b/modules/openapi-generator/src/main/resources/JavaJaxRS/spec/oneof_interface.mustache @@ -16,6 +16,6 @@ public {{>sealed}}interface {{classname}}{{#vendorExtensions.x-implements}}{{#-first}} extends {{{.}}}{{/-first}}{{^-first}}, {{{.}}}{{/-first}}{{/vendorExtensions.x-implements}} {{>permits}}{ {{#discriminator}} - {{propertyType}} {{propertyGetter}}(); + {{propertyType}} {{#useRecords}}{{propertyName}}{{/useRecords}}{{^useRecords}}{{propertyGetter}}{{/useRecords}}(); {{/discriminator}} } diff --git a/modules/openapi-generator/src/main/resources/JavaJaxRS/spec/pom.mustache b/modules/openapi-generator/src/main/resources/JavaJaxRS/spec/pom.mustache index 1bb91b263368..bb12d226169d 100644 --- a/modules/openapi-generator/src/main/resources/JavaJaxRS/spec/pom.mustache +++ b/modules/openapi-generator/src/main/resources/JavaJaxRS/spec/pom.mustache @@ -184,7 +184,7 @@ {{/openApiNullable}} - {{#useSealed}}17{{/useSealed}}{{^useSealed}}1.8{{/useSealed}} + {{#useSealed}}17{{/useSealed}}{{^useSealed}}{{#useRecords}}17{{/useRecords}}{{^useRecords}}1.8{{/useRecords}}{{/useSealed}} ${java.version} ${java.version} UTF-8 diff --git a/modules/openapi-generator/src/main/resources/JavaJaxRS/spec/record.mustache b/modules/openapi-generator/src/main/resources/JavaJaxRS/spec/record.mustache new file mode 100644 index 000000000000..22430e7affd9 --- /dev/null +++ b/modules/openapi-generator/src/main/resources/JavaJaxRS/spec/record.mustache @@ -0,0 +1,64 @@ +{{#useSwaggerAnnotations}} +import io.swagger.annotations.*; +{{/useSwaggerAnnotations}} +{{#useSwaggerV3Annotations}} +import io.swagger.v3.oas.annotations.media.Schema; +{{/useSwaggerV3Annotations}} +{{#jackson}} +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonValue; +import com.fasterxml.jackson.annotation.JsonTypeName; +{{/jackson}} +{{#withXml}} +import {{javaxPackage}}.xml.bind.annotation.XmlElement; +import {{javaxPackage}}.xml.bind.annotation.XmlRootElement; +import {{javaxPackage}}.xml.bind.annotation.XmlAccessType; +import {{javaxPackage}}.xml.bind.annotation.XmlAccessorType; +import {{javaxPackage}}.xml.bind.annotation.XmlType; +import {{javaxPackage}}.xml.bind.annotation.XmlEnum; +import {{javaxPackage}}.xml.bind.annotation.XmlEnumValue; +{{/withXml}} + +{{#discriminator}}{{>typeInfoAnnotation}}{{/discriminator}}{{#description}}/** + * {{.}} + {{#isDeprecated}} + * @deprecated + {{/isDeprecated}} + **/{{/description}} +{{#isDeprecated}} +@Deprecated + +{{/isDeprecated}}{{#useSwaggerAnnotations}}{{#description}}@ApiModel(description = "{{{.}}}"){{/description}}{{/useSwaggerAnnotations}}{{#useSwaggerV3Annotations}} +@Schema({{#title}}title="{{{.}}}", {{/title}}{{#description}}description="{{{.}}}"{{/description}}{{^description}}description=""{{/description}}{{#isDeprecated}}, deprecated = true{{/isDeprecated}}){{/useSwaggerV3Annotations}}{{#useMicroProfileOpenAPIAnnotations}} +@org.eclipse.microprofile.openapi.annotations.media.Schema({{#title}}title="{{{.}}}", {{/title}}{{#description}}description="{{{.}}}"{{/description}}{{^description}}description=""{{/description}}{{#isDeprecated}}, deprecated = true{{/isDeprecated}}){{/useMicroProfileOpenAPIAnnotations}} +{{#jackson}} +@JsonTypeName("{{#vendorExtensions.x-discriminator-value}}{{{vendorExtensions.x-discriminator-value}}}{{/vendorExtensions.x-discriminator-value}}{{^vendorExtensions.x-discriminator-value}}{{name}}{{/vendorExtensions.x-discriminator-value}}") +{{/jackson}} +{{>generatedAnnotation}}{{>additionalModelTypeAnnotations}} +{{#vendorExtensions.x-class-extra-annotation}} +{{{vendorExtensions.x-class-extra-annotation}}} +{{/vendorExtensions.x-class-extra-annotation}} +public {{>sealed}}record {{classname}}( + {{#vars}} + {{#vendorExtensions.x-field-extra-annotation}} + {{{.}}} + {{/vendorExtensions.x-field-extra-annotation}} + {{#deprecated}} + @Deprecated + {{/deprecated}} + {{#jackson}}@JsonProperty({{#required}}required = {{required}}, value = {{/required}}"{{baseName}}") {{/jackson}}{{#useBeanValidation}}{{>beanValidation}}{{/useBeanValidation}}{{{datatypeWithEnum}}} {{name}}{{^-last}},{{/-last}} + {{/vars}} +) {{#vendorExtensions.x-implements}}{{#-first}}implements {{{.}}}{{/-first}}{{^-first}}, {{{.}}}{{/-first}}{{/vendorExtensions.x-implements}} { + {{#vars}} + {{#isEnum}} + {{^isContainer}} + {{>enumClass}}{{! prevent indent}} + {{/isContainer}} + {{#isContainer}} + {{#mostInnerItems}} + {{>enumClass}}{{! prevent indent}} + {{/mostInnerItems}} + {{/isContainer}} + {{/isEnum}} + {{/vars}} +} diff --git a/modules/openapi-generator/src/main/resources/JavaJaxRS/spec/sealed.mustache b/modules/openapi-generator/src/main/resources/JavaJaxRS/spec/sealed.mustache index a5c0af002702..6c860355c15f 100644 --- a/modules/openapi-generator/src/main/resources/JavaJaxRS/spec/sealed.mustache +++ b/modules/openapi-generator/src/main/resources/JavaJaxRS/spec/sealed.mustache @@ -1 +1 @@ -{{#useSealed}}{{#permits.0}}sealed {{/permits.0}}{{^permits.0}}{{^vendorExtensions.x-is-one-of-interface}}final {{/vendorExtensions.x-is-one-of-interface}}{{/permits.0}}{{/useSealed}} \ No newline at end of file +{{#useSealed}}{{#permits.0}}sealed {{/permits.0}}{{^permits.0}}{{^vendorExtensions.x-is-one-of-interface}}{{^vendorExtensions.x-jaxrs-record}}final {{/vendorExtensions.x-jaxrs-record}}{{/vendorExtensions.x-is-one-of-interface}}{{/permits.0}}{{/useSealed}} \ No newline at end of file diff --git a/modules/openapi-generator/src/test/java/org/openapitools/codegen/java/jaxrs/JavaJAXRSSpecServerCodegenTest.java b/modules/openapi-generator/src/test/java/org/openapitools/codegen/java/jaxrs/JavaJAXRSSpecServerCodegenTest.java index 0e341bad2fee..ba70f0a5178d 100644 --- a/modules/openapi-generator/src/test/java/org/openapitools/codegen/java/jaxrs/JavaJAXRSSpecServerCodegenTest.java +++ b/modules/openapi-generator/src/test/java/org/openapitools/codegen/java/jaxrs/JavaJAXRSSpecServerCodegenTest.java @@ -1532,6 +1532,63 @@ public void testWithoutUseSealedOutputIsUnchanged() throws Exception { assertFileContains(Paths.get(outputDir + "/pom.xml"), "1.8"); } + /** + * With {@code useRecords=true} the concrete subtypes of a generated oneOf interface render as Java + * records rather than mutable classes. Because a record component {@code petType} exposes the + * canonical accessor {@code petType()} (not {@code getPetType()}), the interface declares the + * discriminator accessor in record style so the records satisfy it without bridge methods. The + * record components carry the {@code @JsonProperty} annotations. Combined here with + * {@code useSealed=true} so the interface is also sealed and permits the record subtypes. + */ + @Test + public void testOneOfRecordImplementationGeneration() throws Exception { + File output = Files.createTempDirectory("test").toFile().getCanonicalFile(); + output.deleteOnExit(); + + Map properties = new HashMap<>(); + properties.put("useOneOfInterfaces", "true"); + properties.put("useSealed", "true"); + properties.put("useRecords", "true"); + + final CodegenConfigurator configurator = new CodegenConfigurator() + .setGeneratorName("jaxrs-spec") + .setAdditionalProperties(properties) + .setInputSpec("src/test/resources/3_0/jaxrs-spec/oneof_interface.yaml") + .setOutputDir(output.getAbsolutePath().replace("\\", "/")); + + DefaultGenerator generator = new DefaultGenerator(); + generator.opts(configurator.toClientOptInput()).generate(); + + // assertFileContains is used rather than JavaFileAssert because the latter parses the source + // with a JavaParser language level that predates sealed/record types. + String modelDir = output.getAbsolutePath().replace("\\", "/") + "/src/gen/java/org/openapitools/model/"; + + // The interface is sealed, permits the record subtypes, and declares the discriminator accessor + // in record style (petType(), not getPetType()) so the records implement it via their canonical + // accessors. + assertFileContains(Paths.get(modelDir + "PetRequest.java"), + "public sealed interface PetRequest", + "permits CatRequest, DogRequest", + "PetType petType();"); + assertFileNotContains(Paths.get(modelDir + "PetRequest.java"), "getPetType"); + + // The concrete subtypes are records implementing (not extending) the interface, with @JsonProperty + // on the components and no JavaBean getters or final-class declaration. + assertFileContains(Paths.get(modelDir + "CatRequest.java"), + "public record CatRequest(", + "@JsonProperty(required = true, value = \"petType\")", + "PetType petType", + "implements PetRequest"); + assertFileNotContains(Paths.get(modelDir + "CatRequest.java"), + "class CatRequest", "extends PetRequest", "public PetType getPetType()"); + + assertFileContains(Paths.get(modelDir + "DogRequest.java"), + "public record DogRequest(", + "implements PetRequest"); + assertFileNotContains(Paths.get(modelDir + "DogRequest.java"), + "class DogRequest", "extends PetRequest"); + } + @Test public void testGenerateJsonNullableListFieldsHelperMethodReferences_issue23251() throws Exception { Map properties = new HashMap<>(); diff --git a/samples/server/petstore/jaxrs-spec-records/.openapi-generator-ignore b/samples/server/petstore/jaxrs-spec-records/.openapi-generator-ignore new file mode 100644 index 000000000000..7484ee590a38 --- /dev/null +++ b/samples/server/petstore/jaxrs-spec-records/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/samples/server/petstore/jaxrs-spec-records/.openapi-generator/FILES b/samples/server/petstore/jaxrs-spec-records/.openapi-generator/FILES new file mode 100644 index 000000000000..a83382320388 --- /dev/null +++ b/samples/server/petstore/jaxrs-spec-records/.openapi-generator/FILES @@ -0,0 +1,11 @@ +README.md +pom.xml +src/gen/java/org/openapitools/api/PetsApi.java +src/gen/java/org/openapitools/api/RestApplication.java +src/gen/java/org/openapitools/api/RestResourceRoot.java +src/gen/java/org/openapitools/model/CatRequest.java +src/gen/java/org/openapitools/model/DogRequest.java +src/gen/java/org/openapitools/model/PetBase.java +src/gen/java/org/openapitools/model/PetRequest.java +src/gen/java/org/openapitools/model/PetType.java +src/main/openapi/openapi.yaml diff --git a/samples/server/petstore/jaxrs-spec-records/.openapi-generator/VERSION b/samples/server/petstore/jaxrs-spec-records/.openapi-generator/VERSION new file mode 100644 index 000000000000..186c33c96ed8 --- /dev/null +++ b/samples/server/petstore/jaxrs-spec-records/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.24.0-SNAPSHOT diff --git a/samples/server/petstore/jaxrs-spec-records/README.md b/samples/server/petstore/jaxrs-spec-records/README.md new file mode 100644 index 000000000000..b9d190efc443 --- /dev/null +++ b/samples/server/petstore/jaxrs-spec-records/README.md @@ -0,0 +1,27 @@ +# JAX-RS server with OpenAPI + +## Overview +This server was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using an +[OpenAPI-Spec](https://openapis.org), you can easily generate a server stub. + +This is an example of building a OpenAPI-enabled JAX-RS server. +This example uses the [JAX-RS](https://jax-rs-spec.java.net/) framework. + + +The JAX-RS implementation needs to be provided by the application server you are deploying on. + +To run the server from the command line, you can use maven to provision and start a TomEE Server. +Please execute the following: + +``` +mvn -Dtomee-embedded-plugin.http=8080 package org.apache.tomee.maven:tomee-embedded-maven-plugin:7.0.5:run +``` + +You can then call your server endpoints under: + +``` +http://localhost:8080/ +``` + +Note that if you have configured the `host` to be something other than localhost, the calls through +swagger-ui will be directed to that host and not localhost! diff --git a/samples/server/petstore/jaxrs-spec-records/pom.xml b/samples/server/petstore/jaxrs-spec-records/pom.xml new file mode 100644 index 000000000000..f02d739ce00d --- /dev/null +++ b/samples/server/petstore/jaxrs-spec-records/pom.xml @@ -0,0 +1,149 @@ + + 4.0.0 + org.openapitools + jaxrs-spec-records-petstore-server + war + jaxrs-spec-records-petstore-server + 1.0.0 + + + + src/main/java + + + org.codehaus.mojo + build-helper-maven-plugin + 1.9.1 + + + add-source + generate-sources + + add-source + + + + src/gen/java + + + + + + + org.apache.maven.plugins + maven-war-plugin + 3.1.0 + + false + + + + maven-surefire-plugin + 3.5.6 + + + maven-failsafe-plugin + 3.5.6 + + + + integration-test + verify + + + + + + + + + jakarta.ws.rs + jakarta.ws.rs-api + ${jakarta.ws.rs-version} + provided + + + com.fasterxml.jackson.datatype + jackson-datatype-jsr310 + ${jackson-version} + + + com.fasterxml.jackson.jaxrs + jackson-jaxrs-json-provider + ${jackson-version} + + + joda-time + joda-time + ${joda-version} + + + javax.annotation + javax.annotation-api + ${javax.annotation-api-version} + + + io.swagger + swagger-annotations + provided + 1.5.3 + + + + com.google.code.findbugs + jsr305 + 3.0.2 + + + org.junit.jupiter + junit-jupiter-engine + ${junit-version} + test + + + org.testng + testng + 6.8.8 + test + + + junit + junit + + + snakeyaml + org.yaml + + + bsh + org.beanshell + + + + + + jakarta.validation + jakarta.validation-api + ${beanvalidation-version} + provided + + + org.openapitools + jackson-databind-nullable + ${jackson-databind-nullable-version} + + + + 17 + ${java.version} + ${java.version} + UTF-8 + 2.19.2 + 5.14.4 + 2.10.13 + 1.3.2 + 2.0.2 + 2.1.6 + 0.2.10 + + diff --git a/samples/server/petstore/jaxrs-spec-records/src/gen/java/org/openapitools/api/PetsApi.java b/samples/server/petstore/jaxrs-spec-records/src/gen/java/org/openapitools/api/PetsApi.java new file mode 100644 index 000000000000..29a135a553cf --- /dev/null +++ b/samples/server/petstore/jaxrs-spec-records/src/gen/java/org/openapitools/api/PetsApi.java @@ -0,0 +1,33 @@ +package org.openapitools.api; + +import org.openapitools.model.PetRequest; + +import javax.ws.rs.*; +import javax.ws.rs.core.Response; + +import io.swagger.annotations.*; + +import java.io.InputStream; +import java.util.Map; +import java.util.List; +import javax.validation.constraints.*; +import javax.validation.Valid; + +/** +* Represents a collection of functions to interact with the API endpoints. +*/ +@Path("/pets") +@Api(description = "the pets API") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaJAXRSSpecServerCodegen", comments = "Generator version: 7.24.0-SNAPSHOT") +public class PetsApi { + + @POST + @Consumes({ "application/json" }) + @ApiOperation(value = "", notes = "", response = Void.class, tags={ }) + @ApiResponses(value = { + @ApiResponse(code = 201, message = "created", response = Void.class) + }) + public Response createPet(@Valid @NotNull PetRequest petRequest) { + return Response.ok().entity("magic!").build(); + } +} diff --git a/samples/server/petstore/jaxrs-spec-records/src/gen/java/org/openapitools/api/RestApplication.java b/samples/server/petstore/jaxrs-spec-records/src/gen/java/org/openapitools/api/RestApplication.java new file mode 100644 index 000000000000..7df2d0fe3334 --- /dev/null +++ b/samples/server/petstore/jaxrs-spec-records/src/gen/java/org/openapitools/api/RestApplication.java @@ -0,0 +1,9 @@ +package org.openapitools.api; + +import javax.ws.rs.ApplicationPath; +import javax.ws.rs.core.Application; + +@ApplicationPath(RestResourceRoot.APPLICATION_PATH) +public class RestApplication extends Application { + +} diff --git a/samples/server/petstore/jaxrs-spec-records/src/gen/java/org/openapitools/api/RestResourceRoot.java b/samples/server/petstore/jaxrs-spec-records/src/gen/java/org/openapitools/api/RestResourceRoot.java new file mode 100644 index 000000000000..727f0dfe3fb3 --- /dev/null +++ b/samples/server/petstore/jaxrs-spec-records/src/gen/java/org/openapitools/api/RestResourceRoot.java @@ -0,0 +1,5 @@ +package org.openapitools.api; + +public class RestResourceRoot { + public static final String APPLICATION_PATH = ""; +} diff --git a/samples/server/petstore/jaxrs-spec-records/src/gen/java/org/openapitools/model/CatRequest.java b/samples/server/petstore/jaxrs-spec-records/src/gen/java/org/openapitools/model/CatRequest.java new file mode 100644 index 000000000000..896a26e7c1c3 --- /dev/null +++ b/samples/server/petstore/jaxrs-spec-records/src/gen/java/org/openapitools/model/CatRequest.java @@ -0,0 +1,28 @@ +package org.openapitools.model; + +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import org.openapitools.model.PetType; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonSubTypes; +import com.fasterxml.jackson.annotation.JsonTypeInfo; +import java.io.Serializable; +import javax.validation.constraints.*; +import javax.validation.Valid; + +import io.swagger.annotations.*; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonValue; +import com.fasterxml.jackson.annotation.JsonTypeName; + + + +@JsonTypeName("CAT") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaJAXRSSpecServerCodegen", comments = "Generator version: 7.24.0-SNAPSHOT") +public record CatRequest( + @JsonProperty(required = true, value = "petType") @NotNull PetType petType, + @JsonProperty(required = true, value = "name") @NotNull String name, + @JsonProperty(required = true, value = "indoor") @NotNull Boolean indoor +) implements Serializable, PetRequest { +} + diff --git a/samples/server/petstore/jaxrs-spec-records/src/gen/java/org/openapitools/model/DogRequest.java b/samples/server/petstore/jaxrs-spec-records/src/gen/java/org/openapitools/model/DogRequest.java new file mode 100644 index 000000000000..081da6e277ac --- /dev/null +++ b/samples/server/petstore/jaxrs-spec-records/src/gen/java/org/openapitools/model/DogRequest.java @@ -0,0 +1,28 @@ +package org.openapitools.model; + +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import org.openapitools.model.PetType; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonSubTypes; +import com.fasterxml.jackson.annotation.JsonTypeInfo; +import java.io.Serializable; +import javax.validation.constraints.*; +import javax.validation.Valid; + +import io.swagger.annotations.*; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonValue; +import com.fasterxml.jackson.annotation.JsonTypeName; + + + +@JsonTypeName("DOG") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaJAXRSSpecServerCodegen", comments = "Generator version: 7.24.0-SNAPSHOT") +public record DogRequest( + @JsonProperty(required = true, value = "petType") @NotNull PetType petType, + @JsonProperty(required = true, value = "name") @NotNull String name, + @JsonProperty(required = true, value = "trained") @NotNull Boolean trained +) implements Serializable, PetRequest { +} + diff --git a/samples/server/petstore/jaxrs-spec-records/src/gen/java/org/openapitools/model/PetBase.java b/samples/server/petstore/jaxrs-spec-records/src/gen/java/org/openapitools/model/PetBase.java new file mode 100644 index 000000000000..2ad4e6c717b4 --- /dev/null +++ b/samples/server/petstore/jaxrs-spec-records/src/gen/java/org/openapitools/model/PetBase.java @@ -0,0 +1,115 @@ +package org.openapitools.model; + +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import org.openapitools.model.PetType; +import java.io.Serializable; +import javax.validation.constraints.*; +import javax.validation.Valid; + +import io.swagger.annotations.*; +import java.util.Objects; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import com.fasterxml.jackson.annotation.JsonTypeName; +import org.openapitools.jackson.nullable.JsonNullable; + + + +@JsonTypeName("PetBase") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaJAXRSSpecServerCodegen", comments = "Generator version: 7.24.0-SNAPSHOT") +public final class PetBase implements Serializable { + private PetType petType; + private String name; + + public PetBase() { + } + + @JsonCreator + public PetBase( + @JsonProperty(required = true, value = "petType") PetType petType, + @JsonProperty(required = true, value = "name") String name + ) { + this.petType = petType; + this.name = name; + } + + /** + **/ + public PetBase petType(PetType petType) { + this.petType = petType; + return this; + } + + + @ApiModelProperty(required = true, value = "") + @JsonProperty(required = true, value = "petType") + @NotNull public PetType getPetType() { + return petType; + } + + @JsonProperty(required = true, value = "petType") + public void setPetType(PetType petType) { + this.petType = petType; + } + + /** + **/ + public PetBase name(String name) { + this.name = name; + return this; + } + + + @ApiModelProperty(required = true, value = "") + @JsonProperty(required = true, value = "name") + @NotNull public String getName() { + return name; + } + + @JsonProperty(required = true, value = "name") + public void setName(String name) { + this.name = name; + } + + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PetBase petBase = (PetBase) o; + return Objects.equals(this.petType, petBase.petType) && + Objects.equals(this.name, petBase.name); + } + + @Override + public int hashCode() { + return Objects.hash(petType, name); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class PetBase {\n"); + + sb.append(" petType: ").append(toIndentedString(petType)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + return o == null ? "null" : o.toString().replace("\n", "\n "); + } + + +} diff --git a/samples/server/petstore/jaxrs-spec-records/src/gen/java/org/openapitools/model/PetRequest.java b/samples/server/petstore/jaxrs-spec-records/src/gen/java/org/openapitools/model/PetRequest.java new file mode 100644 index 000000000000..2875ec459566 --- /dev/null +++ b/samples/server/petstore/jaxrs-spec-records/src/gen/java/org/openapitools/model/PetRequest.java @@ -0,0 +1,30 @@ +package org.openapitools.model; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonSubTypes; +import com.fasterxml.jackson.annotation.JsonTypeInfo; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import org.openapitools.model.CatRequest; +import org.openapitools.model.DogRequest; +import org.openapitools.model.PetType; +import java.io.Serializable; +import javax.validation.constraints.*; +import javax.validation.Valid; + + +@JsonIgnoreProperties( + value = "petType", // ignore manually set petType, it will be automatically generated by Jackson during serialization + allowSetters = true // allows the petType to be set during deserialization +) +@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "petType", visible = true) +@JsonSubTypes({ + @JsonSubTypes.Type(value = CatRequest.class, name = "CAT"), + @JsonSubTypes.Type(value = DogRequest.class, name = "DOG"), +}) + +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaJAXRSSpecServerCodegen", comments = "Generator version: 7.24.0-SNAPSHOT") +public sealed interface PetRequest extends Serializable permits CatRequest, DogRequest { + PetType petType(); +} + diff --git a/samples/server/petstore/jaxrs-spec-records/src/gen/java/org/openapitools/model/PetType.java b/samples/server/petstore/jaxrs-spec-records/src/gen/java/org/openapitools/model/PetType.java new file mode 100644 index 000000000000..d1640b03bdde --- /dev/null +++ b/samples/server/petstore/jaxrs-spec-records/src/gen/java/org/openapitools/model/PetType.java @@ -0,0 +1,59 @@ +package org.openapitools.model; + +import io.swagger.annotations.ApiModel; +import java.io.Serializable; +import javax.validation.constraints.*; +import javax.validation.Valid; + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; + +/** + * Discriminator value identifying the type of pet + */ +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaJAXRSSpecServerCodegen", comments = "Generator version: 7.24.0-SNAPSHOT") +public enum PetType { + + CAT("CAT"), + + DOG("DOG"); + + private String value; + + PetType(String value) { + this.value = value; + } + + /** + * Convert a String into String, as specified in the + * See JAX RS 2.0 Specification, section 3.2, p. 12 + */ + public static PetType fromString(String s) { + for (PetType b : PetType.values()) { + // using Objects.toString() to be safe if value type non-object type + // because types like 'int' etc. will be auto-boxed + if (java.util.Objects.toString(b.value).equals(s)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected string value '" + s + "'"); + } + + @Override + @JsonValue + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static PetType fromValue(String value) { + for (PetType b : PetType.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } +} + + diff --git a/samples/server/petstore/jaxrs-spec-records/src/main/openapi/openapi.yaml b/samples/server/petstore/jaxrs-spec-records/src/main/openapi/openapi.yaml new file mode 100644 index 000000000000..d25698f6a4c1 --- /dev/null +++ b/samples/server/petstore/jaxrs-spec-records/src/main/openapi/openapi.yaml @@ -0,0 +1,78 @@ +openapi: 3.0.3 +info: + description: | + A oneOf interface whose subtypes inherit shared properties from a base schema (acyclic pattern). The discriminator property is declared on the oneOf container and on the shared base the subtypes inherit via allOf, so the interface getter type resolves to the enum from the container's own properties. + title: oneOf interface + version: 1.0.0 +servers: +- url: / +paths: + /pets: + post: + operationId: createPet + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/PetRequest" + required: true + responses: + "201": + description: created + x-content-type: application/json + x-accepts: + - application/json +components: + schemas: + PetType: + description: Discriminator value identifying the type of pet + enum: + - CAT + - DOG + type: string + PetRequest: + discriminator: + mapping: + CAT: "#/components/schemas/CatRequest" + DOG: "#/components/schemas/DogRequest" + propertyName: petType + example: + petType: CAT + oneOf: + - $ref: "#/components/schemas/CatRequest" + - $ref: "#/components/schemas/DogRequest" + properties: + petType: + $ref: "#/components/schemas/PetType" + type: object + x-one-of-name: PetRequest + PetBase: + properties: + petType: + $ref: "#/components/schemas/PetType" + name: + type: string + required: + - name + - petType + type: object + CatRequest: + allOf: + - $ref: "#/components/schemas/PetBase" + - properties: + indoor: + type: boolean + required: + - indoor + type: object + type: object + DogRequest: + allOf: + - $ref: "#/components/schemas/PetBase" + - properties: + trained: + type: boolean + required: + - trained + type: object + type: object