[Java] Feature/wrapped types and default values #11666
There are no files selected for viewing
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,11 @@ | ||
| generatorName: spring | ||
| outputDir: samples/openapi3/server/petstore/springboot | ||
| inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore-nullable.yaml | ||
| templateDir: modules/openapi-generator/src/main/resources/JavaSpring | ||
| additionalProperties: | ||
| groupId: org.openapitools.openapi3 | ||
| documentationProvider: springdoc | ||
| useOptional: true | ||
| artifactId: springboot | ||
| snapshotVersion: "true" | ||
| hideGenerationTimestamp: "true" |
This file contains 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
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| {{#isWrapped}}{{{wrapperType}}}<{{{datatypeWithEnum}}}>{{/isWrapped}}{{^isWrapped}}{{{datatypeWithEnum}}}{{/isWrapped}} |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| {{#isWrapped}}{{{wrapperType}}}<{{#useBeanValidation}}{{>beanValidationCore}}{{/useBeanValidation}}{{{datatypeWithEnum}}}>{{/isWrapped}}{{^isWrapped}}{{{datatypeWithEnum}}}{{/isWrapped}} |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -49,39 +49,28 @@ public class {{classname}} {{#parent}}extends {{{.}}}{{/parent}}{{^parent}}{{#ha | |
| @SerializedName("{{baseName}}") | ||
| {{/gson}} | ||
| {{#isContainer}} | ||
| {{#useBeanValidation}} | ||
| @Valid | ||
| {{/useBeanValidation}} | ||
| {{/isContainer}} | ||
| {{#isDate}} | ||
| @DateTimeFormat(iso = DateTimeFormat.ISO.DATE) | ||
| {{/isDate}} | ||
| {{#isDateTime}} | ||
| @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) | ||
| {{/isDateTime}} | ||
| private {{>dataType}} {{name}}{{#defaultValue}} = {{{defaultValue}}}{{/defaultValue}}; | ||
|
There was a problem hiding this comment. Worth noting: This changes the default way that containers were working before (defaulted to |
||
| {{/vars}} | ||
| {{#vars}} | ||
|
|
||
| {{! begin feature: fluent setter methods }} | ||
| public {{classname}} {{name}}({{{datatypeWithEnum}}} {{name}}) { | ||
| {{#isWrapped}} | ||
| this.{{name}} = {{wrapperFunc}}({{name}}); | ||
| {{/isWrapped}} | ||
| {{^isWrapped}} | ||
| this.{{name}} = {{name}}; | ||
| {{/isWrapped}} | ||
| return this; | ||
| } | ||
| {{#isArray}} | ||
|
|
@@ -90,7 +79,7 @@ public class {{classname}} {{#parent}}extends {{{.}}}{{/parent}}{{^parent}}{{#ha | |
| {{#openApiNullable}} | ||
| {{^required}} | ||
| if (this.{{name}} == null{{#isNullable}} || !this.{{name}}.isPresent(){{/isNullable}}) { | ||
| this.{{name}} = {{{defaultValue}}}; | ||
| } | ||
| {{/required}} | ||
| this.{{name}}{{#isNullable}}.get(){{/isNullable}}.add({{name}}Item); | ||
|
|
@@ -137,25 +126,42 @@ public class {{classname}} {{#parent}}extends {{{.}}}{{/parent}}{{^parent}}{{#ha | |
| {{#vendorExtensions.x-extra-annotation}} | ||
| {{{vendorExtensions.x-extra-annotation}}} | ||
| {{/vendorExtensions.x-extra-annotation}} | ||
| {{^isWrapped}} | ||
| {{#useBeanValidation}} | ||
| {{>beanValidation}} | ||
| {{/useBeanValidation}} | ||
| {{/isWrapped}} | ||
| {{#swagger2AnnotationLibrary}} | ||
| @Schema(name = "{{{baseName}}}", {{#isReadOnly}}accessMode = Schema.AccessMode.READ_ONLY, {{/isReadOnly}}{{#example}}example = "{{{.}}}", {{/example}}{{#description}}description = "{{{.}}}", {{/description}}required = {{{required}}}) | ||
| {{/swagger2AnnotationLibrary}} | ||
| {{#swagger1AnnotationLibrary}} | ||
| @ApiModelProperty({{#example}}example = "{{{.}}}", {{/example}}{{#required}}required = {{required}}, {{/required}}{{#isReadOnly}}readOnly = {{{isReadOnly}}}, {{/isReadOnly}}value = "{{{description}}}") | ||
| {{/swagger1AnnotationLibrary}} | ||
| public {{>dataType_beanValidation}} {{getter}}() { | ||
| return {{name}}; | ||
| } | ||
|
|
||
| {{#vendorExtensions.x-setter-extra-annotation}} | ||
| {{{vendorExtensions.x-setter-extra-annotation}}} | ||
| {{/vendorExtensions.x-setter-extra-annotation}} | ||
| {{^x-expose-wrapper-in-setter}} | ||
| {{#isWrapped}} | ||
| @JsonIgnore | ||
|
There was a problem hiding this comment. Might be worth documenting why JsonIgnore is needed? There was a problem hiding this comment. Okay, what do we need @JsonIgnore for? I added because you have advised to do so. There was a problem hiding this comment. Jackson will automatically look at all public In order to make sure that this doesn't expect two different fields (one for the |
||
| {{/isWrapped}} | ||
| public void {{setter}}({{{datatypeWithEnum}}} {{name}}) { | ||
cachescrubber marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| {{#isWrapped}} | ||
| this.{{name}} = {{wrapperFunc}}({{name}}); | ||
| {{/isWrapped}} | ||
| {{^isWrapped}} | ||
| this.{{name}} = {{name}}; | ||
| {{/isWrapped}} | ||
| } | ||
| {{/x-expose-wrapper-in-setter}} | ||
| {{#x-expose-wrapper-in-setter}} | ||
| public void {{setter}}({{>dataType}} {{name}}) { | ||
| this.{{name}} = {{name}}; | ||
| } | ||
| {{/x-expose-wrapper-in-setter}} | ||
| {{! end feature: getter and setter }} | ||
| {{/vars}} | ||
|
|
||
|
|
||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think if optionals are enabled, it would be nice for non-nullable non-required maps/arrays to default to empty map/array instead of
nullsince an empty list/map has the same meanining as anullone in that case.