[Spring][server] oneOf Interface for Spring Boot #10392

wing328 · 2021-09-14T04:37:03Z

Resolved merge conflicts for #8091

PR checklist

Read the contribution guidelines.
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.
Run the following to build the project and update samples:
```
./mvnw clean package 
./bin/generate-samples.sh
./bin/utils/export_docs_generators.sh
```
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*.
For Windows users, please run the script in Git BASH.
File the PR against the correct branch: master (5.3.0), 6.0.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.

cc @bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10) @nmuesch (2021/01)

added x-is-one-of-interface extension for oneOf interface in mustache template

fixed name of model from UNKNOWN_BASE_TYPE to right one in api: operationId + OneOf Fix #5381 parcelableModel is not required

removed not needed methods

catch NPE cases in preprocessOpenAPI updated samples

…rator into spring_fix_5381

fixed generation of oneOf Models

addOneOfInterfaceModel only for cases when useOneOfInterfaces is true and for spring

NPE fix

…rator into spring_fix_5381

…rator into spring_fix_5381 � Conflicts: � modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java

spring: fixed use of oneOf Models in API

implementing oneOf for spring lib overriding methods with different behavior from default

added x-is-one-of-interface extension for oneOf interface in mustache template

fixed name of model from UNKNOWN_BASE_TYPE to right one in api: operationId + OneOf Fix #5381 removed not needed methods Fix #5381 fixed generation of oneOf Models Fix #5381 addOneOfInterfaceModel only for cases when useOneOfInterfaces is true and for spring Fix #5381 NPE fix for tests

fixed handing of composed schema with array

fixed NPE in addOneOfInterfaceModel

fixed generation of oneOf models with descriminator

# Conflicts: # modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java

# Conflicts: # modules/openapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java

# Conflicts: # modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java # modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java

…api-generator into jburgess-spring_fix_5381_jb

Orachigami

There should be a check for JACKSON library. Otherwise, code with GSON will be not compilable.
See PR #10286

Orachigami · 2021-09-14T09:50:59Z

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java

+
+    @Override
+    public void addImportsToOneOfInterface(List<Map<String, String>> imports) {
+        for (String i : Arrays.asList("JsonSubTypes", "JsonTypeInfo")) {


Thanks for the review. Can you please submit a PR against this branch with the suggested fix?

@wing328 I created PR against jburgess-spring_fix_5381_jb #10433 and resolved conflicts

agilob · 2021-09-16T21:06:02Z

.../openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractJavaCodegen.java

+        for (Map<String, Object> mo : models) {
+            CodegenModel cm = (CodegenModel) mo.get("model");
+            if (this.serializableModel) {
+                cm.getVendorExtensions().putIfAbsent("x-implements", new ArrayList<String>());


Use new ArrayList<String>(1) as you know the size upfront

agilob · 2021-09-16T21:06:44Z

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java

+        if (p.defaultValue == null) {
+            return;
+        }
+        Boolean fixLong = (p.isLong && "l".equals(p.defaultValue.substring(p.defaultValue.length()-1)));


use boolean lowercase as values can't be null

agilob · 2021-09-16T21:09:01Z

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java

+    @Override
+    public void addImportsToOneOfInterface(List<Map<String, String>> imports) {
+        for (String i : Arrays.asList("JsonSubTypes", "JsonTypeInfo")) {
+            Map<String, String> oneImport = new HashMap<String, String>() {{


final Map<String, String> oneImport = new HashMap<>(1); oneImport.put("import", importMapping.get(i));

it's faster and more readable. using {{ }} is normally considered antipattern unless in static {} block

unless in static {} block

A lot of people would complain on this too

cachescrubber · 2022-01-11T14:25:38Z

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java

-}
+
+    @Override
+    public void postProcessParameter(CodegenParameter p) {


In the meantime, postProcessParameter() moved to AbstractJavaCodeGen with [Java][Jaxrs-Resteasy] Fixes generator devaultValues for int64/float/… (#8988)

cachescrubber · 2022-01-11T14:52:43Z

.../openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractJavaCodegen.java

+            CodegenModel cm = (CodegenModel) mo.get("model");
+            if (this.serializableModel) {
+                cm.getVendorExtensions().putIfAbsent("x-implements", new ArrayList<String>());
+                ((ArrayList<String>) cm.getVendorExtensions().get("x-implements")).add("Serializable");


x-implements Serializable is at least duplicated in JavaClientCodeGen.

cachescrubber · 2022-01-11T14:54:31Z

@wing328 I really would like to get this done. Should I support / bring this PR up to date?

pedrodovale · 2022-01-12T15:50:54Z

Hi,

I'm also following this PR with great interested. Thanks for the contributor's work on this.

I have a question about this. Taking the committed example ByRefOrValue document as an example: Why is it that the generated FooRefOrValue is an interface and not a class extended by the Foo and FooRef? I ask this because this would be useful in the case where there are common fields. They could be defined in an abstract class and then there could exist getters for more than just the discriminator.propertyName @type.

Apologies if this is explained elsewhere. I didn't find it.

Orachigami · 2022-01-12T22:06:24Z

@cachescrubber @pedrodovale Have you checked this PR #10463 ?

cachescrubber · 2022-01-13T05:29:47Z

@Orachigami Thx for the heads up. I'll have a look at #10463.

@wing328 This PR is still tagged with the 5.4.0 milestone and not closed. Why is that?

cachescrubber · 2022-01-13T05:36:12Z

@wing328 , anyone. Which of the Java generators (if any) has the most complete and stable support for polymorphism (oneOf/anyOf)?

EDIT: The java generator (libraries okhttp-gson-nextgen and jersey2) include an implementation where a wrapper class holding the oneOfs is generated, including a custom Deserializer.

pedrodovale · 2022-01-18T23:18:45Z

@cachescrubber @pedrodovale Have you checked this PR #10463 ?

Yes @Orachigami, I did. Thanks to the oneOf unit tests in the fork I was able to model a type and its subtypes and obtain the classes with the desired JsonSubTypes annotations. I've also got the expected sources using the code in this PR.

Here is the class that contains the unit tests (hope it helps someone): SpringCodegenTest

Cheers!

cachescrubber · 2022-01-27T08:32:55Z

@wing328 The branch has merge conflicts. Could you please merge in the current master? If you need any help merging pojo.java feel free to contact me.

cachescrubber · 2022-01-27T08:43:39Z

@pedrodovale The classes enumerated in the oneOf might allready extend other classes. Thus the marker interface as an implemenation strategy. Your suggestion is also quite reasonable and reminds me on the XSD way to model extensions - which works quite well indeed.

For example the following XSD would generate code as you describe, ie AcceptanceNotificationType extends NotificationType.

  <xs:complexType name="NotificationType">
    <xs:sequence>
      <xs:element name="status" type="com:StatusType"/>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="AcceptanceNotificationType">
    <xs:complexContent>
      <xs:extension base="com:NotificationType">
        <xs:sequence>
          <xs:element name="details" type="com:OrderDetailsType" minOccurs="0"/>
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>

  <xs:complexType name="CompletionNotificationType">
    <xs:complexContent>
      <xs:extension base="com:NotificationType">
        <xs:sequence>
          <xs:element name="completionDate" type="xs:date"/>
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>

cachescrubber · 2022-01-27T08:46:03Z

@wing328 @Orachigami, There will be a clash if the class denoted by the oneOf contains a type property, which is an Enum. The Interface will generate String getType() the concrete class MyType getType(). Should we support this, or is it considered bad modelling?

    Location:
      description: The LocationType that is used in the Order. When Order info is retrieved and the UnitNumber is known, the Location will always be of type LocationWohnEinheitIdBased
      oneOf:
        - $ref: '#/components/schemas/LocationHouseIdBased'
        - $ref: '#/components/schemas/LocationWohnEinheitIdBased'
      example:
        type: HOUSE_ID_BASED
        houseId: "01234ABC-123-A"
      discriminator:
        propertyName: type
        mapping:
          HOUSE_ID_BASED: '#/components/schemas/LocationHouseIdBased'
          WOHNEINHEIT_ID_BASED: '#/components/schemas/LocationWohnEinheitIdBased'

    LocationType:
      type: string
      default: HOUSE_ID_BASED
      description: the type of a Location
      enum:
        - HOUSE_ID_BASED
        - WOHNEINHEIT_ID_BASED

The OAS in question could be downloaded here. Disclaimer: I'am neither the Author nor Api Owner.

wing328 · 2022-03-16T14:50:35Z

Closed via #11650

alexsuperdev and others added 28 commits March 22, 2020 11:15

Fix #5381

6a8769e

added x-is-one-of-interface extension for oneOf interface in mustache template

Fix #5381

049359c

fixed name of model from UNKNOWN_BASE_TYPE to right one in api: operationId + OneOf Fix #5381 parcelableModel is not required

Fix #5381

49f13eb

removed not needed methods

Fix #5381

1a5a484

catch NPE cases in preprocessOpenAPI updated samples

Merge branch 'master' of https://github.com/OpenAPITools/openapi-gene…

66a09d2

…rator into spring_fix_5381

Fix #5381

48a1a4a

fixed generation of oneOf Models

Fix #5381

a811330

addOneOfInterfaceModel only for cases when useOneOfInterfaces is true and for spring

Fix #5381

299cdb3

NPE fix

Merge branch 'master' of https://github.com/OpenAPITools/openapi-gene…

461cbc8

…rator into spring_fix_5381

Merge branch 'master' of https://github.com/OpenAPITools/openapi-gene…

dd0118d

…rator into spring_fix_5381 � Conflicts: � modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java

Fix #5381

26a95f6

spring: fixed use of oneOf Models in API

Fix #5381

9af7db6

implementing oneOf for spring lib overriding methods with different behavior from default

Fix #5381

fbfd57d

added x-is-one-of-interface extension for oneOf interface in mustache template

Fix #5381

29003d8

fixed handing of composed schema with array

Fix #5381

d864831

fixed NPE in addOneOfInterfaceModel

Fix #5381

6d54799

fixed generation of oneOf models with descriminator

Merge remote-tracking branch 'super/master' into spring_fix_5381_jb

c6a5c6b

# Conflicts: # modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java

Merge remote-tracking branch 'super/master' into spring_fix_5381_jb

d96cd2e

Initial merge of 5.0

8f09f52

Aligned with master formatting

0d31df4

Corrected spacing for class names to align with samples.

397e711

Merge remote-tracking branch 'source/master' into spring_fix_5381_jb

a922217

# Conflicts: # modules/openapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java

Merge remote-tracking branch 'source/master' into spring_fix_5381_jb

21a98e5

Merge remote-tracking branch 'source/master' into spring_fix_5381_jb

1b5964e

# Conflicts: # modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java # modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java

Merged master

05105fa

Updated samples

c89a28b

Merge branch 'spring_fix_5381_jb' of https://github.com/jburgess/open…

4808e87

…api-generator into jburgess-spring_fix_5381_jb

wing328 mentioned this pull request Sep 14, 2021

[Spring][server] oneOf Interface for Spring Boot #8091

Closed

6 tasks

Orachigami reviewed Sep 14, 2021

View reviewed changes

wing328 added Feature: OAS 3.0 spec support Server: Spring labels Sep 14, 2021

wing328 added this to the 5.3.0 milestone Sep 14, 2021

agilob reviewed Sep 16, 2021

View reviewed changes

Orachigami mentioned this pull request Sep 22, 2021

[Java][Spring] fix one of #10433

Closed

5 tasks

wing328 modified the milestones: 5.3.0, 5.3.1 Oct 25, 2021

martin-bucinskas mentioned this pull request Nov 30, 2021

[spring] oneOf implementation for spring boot #10993

Open

5 tasks

wing328 modified the milestones: 5.3.1, 5.4.0 Dec 29, 2021

cachescrubber reviewed Jan 11, 2022

View reviewed changes

cachescrubber mentioned this pull request Jan 27, 2022

[Java][Spring] fix one of #10463

Closed

5 tasks

wing328 modified the milestones: 5.4.0, 6.0.0 Jan 31, 2022

cachescrubber mentioned this pull request Feb 18, 2022

[Feature][Java/Spring] Support Discriminator Based OneOf Interface #11650

Merged

wing328 closed this Mar 16, 2022

wing328 deleted the jburgess-spring_fix_5381_jb branch April 4, 2022 01:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Spring][server] oneOf Interface for Spring Boot #10392

[Spring][server] oneOf Interface for Spring Boot #10392

wing328 commented Sep 14, 2021 •

edited

Loading

Orachigami left a comment

Orachigami Sep 14, 2021 •

edited

Loading

wing328 Sep 14, 2021

Orachigami Sep 20, 2021

agilob Sep 16, 2021

agilob Sep 16, 2021

agilob Sep 16, 2021

agilob Sep 16, 2021

cachescrubber Jan 11, 2022

cachescrubber Jan 11, 2022

cachescrubber commented Jan 11, 2022

pedrodovale commented Jan 12, 2022

Orachigami commented Jan 12, 2022 •

edited

Loading

cachescrubber commented Jan 13, 2022

cachescrubber commented Jan 13, 2022 •

edited

Loading

pedrodovale commented Jan 18, 2022

cachescrubber commented Jan 27, 2022

cachescrubber commented Jan 27, 2022 •

edited

Loading

cachescrubber commented Jan 27, 2022 •

edited

Loading

wing328 commented Mar 16, 2022

[Spring][server] oneOf Interface for Spring Boot #10392

[Spring][server] oneOf Interface for Spring Boot #10392

Conversation

wing328 commented Sep 14, 2021 • edited Loading

PR checklist

Orachigami left a comment

Choose a reason for hiding this comment

Orachigami Sep 14, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cachescrubber commented Jan 11, 2022

pedrodovale commented Jan 12, 2022

Orachigami commented Jan 12, 2022 • edited Loading

cachescrubber commented Jan 13, 2022

cachescrubber commented Jan 13, 2022 • edited Loading

pedrodovale commented Jan 18, 2022

cachescrubber commented Jan 27, 2022

cachescrubber commented Jan 27, 2022 • edited Loading

cachescrubber commented Jan 27, 2022 • edited Loading

wing328 commented Mar 16, 2022

wing328 commented Sep 14, 2021 •

edited

Loading

Orachigami Sep 14, 2021 •

edited

Loading

Orachigami commented Jan 12, 2022 •

edited

Loading

cachescrubber commented Jan 13, 2022 •

edited

Loading

cachescrubber commented Jan 27, 2022 •

edited

Loading

cachescrubber commented Jan 27, 2022 •

edited

Loading