Skip to content

[Spring] Fix template for RequestBody, added 'required' attribute#4756

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wing328 merged 2 commits into from
Dec 16, 2019
Merged

[Spring] Fix template for RequestBody, added 'required' attribute #4756

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2db9379
fix template for RequestBody, added 'required' attribute (#3134)
ahrytsiuk Dec 10, 2019
8e40a63
update Spring samples (#3134)
ahrytsiuk Dec 10, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion modules/openapi-generator/src/main/resources/JavaSpring/bodyParams.mustache
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
{{#isBodyParam}}@ApiParam(value = "{{{description}}}" {{#required}},required=true{{/required}} {{^isContainer}}{{#allowableValues}}, allowableValues="{{{allowableValues}}}"{{/allowableValues}}{{#defaultValue}}, defaultValue={{^isString}}"{{/isString}}{{#isString}}{{#isEnum}}"{{/isEnum}}{{/isString}}{{{defaultValue}}}{{^isString}}"{{/isString}}{{#isString}}{{#isEnum}}"{{/isEnum}}{{/isString}}{{/defaultValue}}{{/isContainer}}) {{#useBeanValidation}}@Valid{{/useBeanValidation}} @RequestBody {{^reactive}}{{{dataType}}}{{/reactive}}{{#reactive}}{{^isListContainer}}Mono{{/isListContainer}}{{#isListContainer}}Flux{{/isListContainer}}<{{{baseType}}}>{{/reactive}} {{paramName}}{{/isBodyParam}}
{{#isBodyParam}}@ApiParam(value = "{{{description}}}" {{#required}},required=true{{/required}} {{^isContainer}}{{#allowableValues}}, allowableValues="{{{allowableValues}}}"{{/allowableValues}}{{#defaultValue}}, defaultValue={{^isString}}"{{/isString}}{{#isString}}{{#isEnum}}"{{/isEnum}}{{/isString}}{{{defaultValue}}}{{^isString}}"{{/isString}}{{#isString}}{{#isEnum}}"{{/isEnum}}{{/isString}}{{/defaultValue}}{{/isContainer}}) {{#useBeanValidation}}@Valid{{/useBeanValidation}} @RequestBody{{^required}}(required = false){{/required}} {{^reactive}}{{{dataType}}}{{/reactive}}{{#reactive}}{{^isListContainer}}Mono{{/isListContainer}}{{#isListContainer}}Flux{{/isListContainer}}<{{{baseType}}}>{{/reactive}} {{paramName}}{{/isBodyParam}}
24 changes: 24 additions & 0 deletions ...enapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -416,4 +416,28 @@ public void reactiveRequiredSpringBoot() {
codegen.additionalProperties().put(CodegenConstants.LIBRARY, "spring-cloud");
codegen.processOpts();
}

@Test
public void testDoGenerateRequestBodyRequiredAttribute_3134_Regression() throws Exception {
File output = Files.createTempDirectory("test").toFile().getCanonicalFile();
output.deleteOnExit();
String outputPath = output.getAbsolutePath().replace('\\', '/');

OpenAPI openAPI = new OpenAPIParser()
.readLocation("src/test/resources/3_0/3134-regression.yaml", null, new ParseOptions()).getOpenAPI();

SpringCodegen codegen = new SpringCodegen();
codegen.setOutputDir(output.getAbsolutePath());
codegen.additionalProperties().put(CXFServerFeatures.LOAD_TEST_DATA_FROM_FILE, "true");

ClientOptInput input = new ClientOptInput();
input.setOpenAPI(openAPI);
input.setConfig(codegen);

MockDefaultGenerator generator = new MockDefaultGenerator();
generator.opts(input).generate();

checkFileContains(generator, outputPath + "/src/main/java/org/openapitools/api/ExampleApi.java",
"@RequestBody(required = false");
}
}
23 changes: 23 additions & 0 deletions modules/openapi-generator/src/test/resources/3_0/3134-regression.yaml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
openapi: 3.0.2
info:
title: info
description: info
version: 0.1.0

paths:
/example/api:
post:
summary: summary
description: description
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
name:
type: string
responses:
200:
description: response
8 changes: 4 additions & 4 deletions samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/api/FakeApi.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -78,7 +78,7 @@ default CompletableFuture<ResponseEntity<Void>> createXmlItem(@ApiParam(value =
@RequestMapping(value = "/fake/outer/boolean",
produces = { "*/*" },
method = RequestMethod.POST)
default CompletableFuture<ResponseEntity<Boolean>> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) {
default CompletableFuture<ResponseEntity<Boolean>> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body) {
return CompletableFuture.completedFuture(new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED));

}
Expand All@@ -97,7 +97,7 @@ default CompletableFuture<ResponseEntity<Boolean>> fakeOuterBooleanSerialize(@Ap
@RequestMapping(value = "/fake/outer/composite",
produces = { "*/*" },
method = RequestMethod.POST)
default CompletableFuture<ResponseEntity<OuterComposite>> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) {
default CompletableFuture<ResponseEntity<OuterComposite>> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body) {
return CompletableFuture.supplyAsync(()-> {
getRequest().ifPresent(request -> {
for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
Expand DownExpand Up@@ -127,7 +127,7 @@ default CompletableFuture<ResponseEntity<OuterComposite>> fakeOuterCompositeSeri
@RequestMapping(value = "/fake/outer/number",
produces = { "*/*" },
method = RequestMethod.POST)
default CompletableFuture<ResponseEntity<BigDecimal>> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) {
default CompletableFuture<ResponseEntity<BigDecimal>> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body) {
return CompletableFuture.completedFuture(new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED));

}
Expand All@@ -146,7 +146,7 @@ default CompletableFuture<ResponseEntity<BigDecimal>> fakeOuterNumberSerialize(@
@RequestMapping(value = "/fake/outer/string",
produces = { "*/*" },
method = RequestMethod.POST)
default CompletableFuture<ResponseEntity<String>> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) {
default CompletableFuture<ResponseEntity<String>> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body) {
return CompletableFuture.completedFuture(new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED));

}
Expand Down
8 changes: 4 additions & 4 deletions ...rver/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/api/FakeApi.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -77,7 +77,7 @@ default ResponseEntity<Void> createXmlItem(@ApiParam(value = "XmlItem Body" ,req
@RequestMapping(value = "/fake/outer/boolean",
produces = { "*/*" },
method = RequestMethod.POST)
default ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) {
default ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

}
Expand All@@ -96,7 +96,7 @@ default ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Inp
@RequestMapping(value = "/fake/outer/composite",
produces = { "*/*" },
method = RequestMethod.POST)
default ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) {
default ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body) {
getRequest().ifPresent(request -> {
for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
if (mediaType.isCompatibleWith(MediaType.valueOf("*/*"))) {
Expand DownExpand Up@@ -124,7 +124,7 @@ default ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(val
@RequestMapping(value = "/fake/outer/number",
produces = { "*/*" },
method = RequestMethod.POST)
default ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) {
default ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

}
Expand All@@ -143,7 +143,7 @@ default ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "I
@RequestMapping(value = "/fake/outer/string",
produces = { "*/*" },
method = RequestMethod.POST)
default ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) {
default ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

}
Expand Down
8 changes: 4 additions & 4 deletions samples/server/petstore/spring-mvc/src/main/java/org/openapitools/api/FakeApi.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -66,7 +66,7 @@ public interface FakeApi {
@RequestMapping(value = "/fake/outer/boolean",
produces = { "*/*" },
method = RequestMethod.POST)
ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body);
ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body);


/**
Expand All@@ -82,7 +82,7 @@ public interface FakeApi {
@RequestMapping(value = "/fake/outer/composite",
produces = { "*/*" },
method = RequestMethod.POST)
ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body);
ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body);


/**
Expand All@@ -98,7 +98,7 @@ public interface FakeApi {
@RequestMapping(value = "/fake/outer/number",
produces = { "*/*" },
method = RequestMethod.POST)
ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body);
ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body);


/**
Expand All@@ -114,7 +114,7 @@ public interface FakeApi {
@RequestMapping(value = "/fake/outer/string",
produces = { "*/*" },
method = RequestMethod.POST)
ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body);
ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body);


/**
Expand Down
8 changes: 4 additions & 4 deletions samples/server/petstore/spring-mvc/src/main/java/org/openapitools/api/FakeApiController.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -62,7 +62,7 @@ public ResponseEntity<Void> createXmlItem(@ApiParam(value = "XmlItem Body" ,requ
* @return Output boolean (status code 200)
* @see FakeApi#fakeOuterBooleanSerialize
*/
public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) {
public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

}
Expand All@@ -75,7 +75,7 @@ public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Inpu
* @return Output composite (status code 200)
* @see FakeApi#fakeOuterCompositeSerialize
*/
public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) {
public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body) {
for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
if (mediaType.isCompatibleWith(MediaType.valueOf("*/*"))) {
String exampleString = "{ \"my_string\" : \"my_string\", \"my_number\" : 0.8008281904610115, \"my_boolean\" : true }";
Expand All@@ -95,7 +95,7 @@ public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(valu
* @return Output number (status code 200)
* @see FakeApi#fakeOuterNumberSerialize
*/
public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) {
public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

}
Expand All@@ -108,7 +108,7 @@ public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "In
* @return Output string (status code 200)
* @see FakeApi#fakeOuterStringSerialize
*/
public ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) {
public ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

}
Expand Down
8 changes: 4 additions & 4 deletions ...server/petstore/springboot-beanvalidation/src/main/java/org/openapitools/api/FakeApi.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -66,7 +66,7 @@ public interface FakeApi {
@RequestMapping(value = "/fake/outer/boolean",
produces = { "*/*" },
method = RequestMethod.POST)
ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body);
ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body);


/**
Expand All@@ -82,7 +82,7 @@ public interface FakeApi {
@RequestMapping(value = "/fake/outer/composite",
produces = { "*/*" },
method = RequestMethod.POST)
ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body);
ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body);


/**
Expand All@@ -98,7 +98,7 @@ public interface FakeApi {
@RequestMapping(value = "/fake/outer/number",
produces = { "*/*" },
method = RequestMethod.POST)
ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body);
ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body);


/**
Expand All@@ -114,7 +114,7 @@ public interface FakeApi {
@RequestMapping(value = "/fake/outer/string",
produces = { "*/*" },
method = RequestMethod.POST)
ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body);
ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body);


/**
Expand Down
8 changes: 4 additions & 4 deletions ...store/springboot-beanvalidation/src/main/java/org/openapitools/api/FakeApiController.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -62,7 +62,7 @@ public ResponseEntity<Void> createXmlItem(@ApiParam(value = "XmlItem Body" ,requ
* @return Output boolean (status code 200)
* @see FakeApi#fakeOuterBooleanSerialize
*/
public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) {
public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

}
Expand All@@ -75,7 +75,7 @@ public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Inpu
* @return Output composite (status code 200)
* @see FakeApi#fakeOuterCompositeSerialize
*/
public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) {
public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body) {
for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
if (mediaType.isCompatibleWith(MediaType.valueOf("*/*"))) {
String exampleString = "{ \"my_string\" : \"my_string\", \"my_number\" : 0.8008281904610115, \"my_boolean\" : true }";
Expand All@@ -95,7 +95,7 @@ public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(valu
* @return Output number (status code 200)
* @see FakeApi#fakeOuterNumberSerialize
*/
public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) {
public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

}
Expand All@@ -108,7 +108,7 @@ public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "In
* @return Output string (status code 200)
* @see FakeApi#fakeOuterStringSerialize
*/
public ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) {
public ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
[Spring] Fix template for RequestBody, added 'required' attribute by ahrytsiuk · Pull Request #4756 · OpenAPITools/openapi-generator · GitHub
Skip to content
[Spring] Fix template for RequestBody, added 'required' attribute#4756

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

wing328
merged 2 commits into

from

Dec 16, 2019
 Merged


[Spring] Fix template for RequestBody, added 'required' attribute
#4756
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
2db9379

fix template for RequestBody, added 'required' attribute (#3134)


ahrytsiuk Dec 10, 2019
8e40a63

update Spring samples (#3134)


ahrytsiuk Dec 10, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
modules/openapi-generator/src/main/resources/JavaSpring/bodyParams.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
{{#isBodyParam}}@ApiParam(value = "{{{description}}}" {{#required}},required=true{{/required}} {{^isContainer}}{{#allowableValues}}, allowableValues="{{{allowableValues}}}"{{/allowableValues}}{{#defaultValue}}, defaultValue={{^isString}}"{{/isString}}{{#isString}}{{#isEnum}}"{{/isEnum}}{{/isString}}{{{defaultValue}}}{{^isString}}"{{/isString}}{{#isString}}{{#isEnum}}"{{/isEnum}}{{/isString}}{{/defaultValue}}{{/isContainer}}) {{#useBeanValidation}}@Valid{{/useBeanValidation}} @RequestBody {{^reactive}}{{{dataType}}}{{/reactive}}{{#reactive}}{{^isListContainer}}Mono{{/isListContainer}}{{#isListContainer}}Flux{{/isListContainer}}<{{{baseType}}}>{{/reactive}} {{paramName}}{{/isBodyParam}}
{{#isBodyParam}}@ApiParam(value = "{{{description}}}" {{#required}},required=true{{/required}} {{^isContainer}}{{#allowableValues}}, allowableValues="{{{allowableValues}}}"{{/allowableValues}}{{#defaultValue}}, defaultValue={{^isString}}"{{/isString}}{{#isString}}{{#isEnum}}"{{/isEnum}}{{/isString}}{{{defaultValue}}}{{^isString}}"{{/isString}}{{#isString}}{{#isEnum}}"{{/isEnum}}{{/isString}}{{/defaultValue}}{{/isContainer}}) {{#useBeanValidation}}@Valid{{/useBeanValidation}} @RequestBody{{^required}}(required = false){{/required}} {{^reactive}}{{{dataType}}}{{/reactive}}{{#reactive}}{{^isListContainer}}Mono{{/isListContainer}}{{#isListContainer}}Flux{{/isListContainer}}<{{{baseType}}}>{{/reactive}} {{paramName}}{{/isBodyParam}}

24 changes: 24 additions & 0 deletions
...enapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -416,4 +416,28 @@ public void reactiveRequiredSpringBoot() {
 codegen.additionalProperties().put(CodegenConstants.LIBRARY, "spring-cloud");
 codegen.processOpts();
 }

 @Test
 public void testDoGenerateRequestBodyRequiredAttribute_3134_Regression() throws Exception {
 File output = Files.createTempDirectory("test").toFile().getCanonicalFile();
 output.deleteOnExit();
 String outputPath = output.getAbsolutePath().replace('\\', '/');

 OpenAPI openAPI = new OpenAPIParser()
 .readLocation("src/test/resources/3_0/3134-regression.yaml", null, new ParseOptions()).getOpenAPI();

 SpringCodegen codegen = new SpringCodegen();
 codegen.setOutputDir(output.getAbsolutePath());
 codegen.additionalProperties().put(CXFServerFeatures.LOAD_TEST_DATA_FROM_FILE, "true");

 ClientOptInput input = new ClientOptInput();
 input.setOpenAPI(openAPI);
 input.setConfig(codegen);

 MockDefaultGenerator generator = new MockDefaultGenerator();
 generator.opts(input).generate();

 checkFileContains(generator, outputPath + "/src/main/java/org/openapitools/api/ExampleApi.java",
 "@RequestBody(required = false");
 }
}

23 changes: 23 additions & 0 deletions
modules/openapi-generator/src/test/resources/3_0/3134-regression.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
openapi: 3.0.2
info:
 title: info
 description: info
 version: 0.1.0

paths:
 /example/api:
 post:
 summary: summary
 description: description
 requestBody:
 required: false
 content:
 application/json:
 schema:
 type: object
 properties:
 name:
 type: string
 responses:
 200:
 description: response

8 changes: 4 additions & 4 deletions
samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/api/FakeApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -78,7 +78,7 @@ default CompletableFuture<ResponseEntity<Void>> createXmlItem(@ApiParam(value =
 @RequestMapping(value = "/fake/outer/boolean",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default CompletableFuture<ResponseEntity<Boolean>> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) {
 default CompletableFuture<ResponseEntity<Boolean>> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body) {
 return CompletableFuture.completedFuture(new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED));

 }
Expand All@@ -97,7 +97,7 @@ default CompletableFuture<ResponseEntity<Boolean>> fakeOuterBooleanSerialize(@Ap
 @RequestMapping(value = "/fake/outer/composite",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default CompletableFuture<ResponseEntity<OuterComposite>> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) {
 default CompletableFuture<ResponseEntity<OuterComposite>> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body) {
 return CompletableFuture.supplyAsync(()-> {
 getRequest().ifPresent(request -> {
 for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
Expand DownExpand Up@@ -127,7 +127,7 @@ default CompletableFuture<ResponseEntity<OuterComposite>> fakeOuterCompositeSeri
 @RequestMapping(value = "/fake/outer/number",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default CompletableFuture<ResponseEntity<BigDecimal>> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) {
 default CompletableFuture<ResponseEntity<BigDecimal>> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body) {
 return CompletableFuture.completedFuture(new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED));

 }
Expand All@@ -146,7 +146,7 @@ default CompletableFuture<ResponseEntity<BigDecimal>> fakeOuterNumberSerialize(@
 @RequestMapping(value = "/fake/outer/string",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default CompletableFuture<ResponseEntity<String>> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) {
 default CompletableFuture<ResponseEntity<String>> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body) {
 return CompletableFuture.completedFuture(new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED));

 }
Expand Down

8 changes: 4 additions & 4 deletions
...rver/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/api/FakeApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -77,7 +77,7 @@ default ResponseEntity<Void> createXmlItem(@ApiParam(value = "XmlItem Body" ,req
 @RequestMapping(value = "/fake/outer/boolean",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) {
 default ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand All@@ -96,7 +96,7 @@ default ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Inp
 @RequestMapping(value = "/fake/outer/composite",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) {
 default ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body) {
 getRequest().ifPresent(request -> {
 for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
 if (mediaType.isCompatibleWith(MediaType.valueOf("*/*"))) {
Expand DownExpand Up@@ -124,7 +124,7 @@ default ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(val
 @RequestMapping(value = "/fake/outer/number",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) {
 default ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand All@@ -143,7 +143,7 @@ default ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "I
 @RequestMapping(value = "/fake/outer/string",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) {
 default ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand Down

8 changes: 4 additions & 4 deletions
samples/server/petstore/spring-mvc/src/main/java/org/openapitools/api/FakeApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -66,7 +66,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/boolean",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body);
 ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body);


 /**
Expand All@@ -82,7 +82,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/composite",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body);
 ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body);


 /**
Expand All@@ -98,7 +98,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/number",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body);
 ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body);


 /**
Expand All@@ -114,7 +114,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/string",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body);
 ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body);


 /**
Expand Down

8 changes: 4 additions & 4 deletions
samples/server/petstore/spring-mvc/src/main/java/org/openapitools/api/FakeApiController.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,7 +62,7 @@ public ResponseEntity<Void> createXmlItem(@ApiParam(value = "XmlItem Body" ,requ
 * @return Output boolean (status code 200)
 * @see FakeApi#fakeOuterBooleanSerialize
 */
 public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) {
 public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand All@@ -75,7 +75,7 @@ public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Inpu
 * @return Output composite (status code 200)
 * @see FakeApi#fakeOuterCompositeSerialize
 */
 public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) {
 public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body) {
 for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
 if (mediaType.isCompatibleWith(MediaType.valueOf("*/*"))) {
 String exampleString = "{ \"my_string\" : \"my_string\", \"my_number\" : 0.8008281904610115, \"my_boolean\" : true }";
Expand All@@ -95,7 +95,7 @@ public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(valu
 * @return Output number (status code 200)
 * @see FakeApi#fakeOuterNumberSerialize
 */
 public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) {
 public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand All@@ -108,7 +108,7 @@ public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "In
 * @return Output string (status code 200)
 * @see FakeApi#fakeOuterStringSerialize
 */
 public ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) {
 public ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand Down

8 changes: 4 additions & 4 deletions
...server/petstore/springboot-beanvalidation/src/main/java/org/openapitools/api/FakeApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -66,7 +66,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/boolean",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body);
 ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body);


 /**
Expand All@@ -82,7 +82,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/composite",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body);
 ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body);


 /**
Expand All@@ -98,7 +98,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/number",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body);
 ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body);


 /**
Expand All@@ -114,7 +114,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/string",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body);
 ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body);


 /**
Expand Down

8 changes: 4 additions & 4 deletions
...store/springboot-beanvalidation/src/main/java/org/openapitools/api/FakeApiController.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,7 +62,7 @@ public ResponseEntity<Void> createXmlItem(@ApiParam(value = "XmlItem Body" ,requ
 * @return Output boolean (status code 200)
 * @see FakeApi#fakeOuterBooleanSerialize
 */
 public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) {
 public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand All@@ -75,7 +75,7 @@ public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Inpu
 * @return Output composite (status code 200)
 * @see FakeApi#fakeOuterCompositeSerialize
 */
 public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) {
 public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body) {
 for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
 if (mediaType.isCompatibleWith(MediaType.valueOf("*/*"))) {
 String exampleString = "{ \"my_string\" : \"my_string\", \"my_number\" : 0.8008281904610115, \"my_boolean\" : true }";
Expand All@@ -95,7 +95,7 @@ public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(valu
 * @return Output number (status code 200)
 * @see FakeApi#fakeOuterNumberSerialize
 */
 public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) {
 public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand All@@ -108,7 +108,7 @@ public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "In
 * @return Output string (status code 200)
 * @see FakeApi#fakeOuterStringSerialize
 */
 public ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) {
 public ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[Spring] Fix template for RequestBody, added 'required' attribute by ahrytsiuk · Pull Request #4756 · OpenAPITools/openapi-generator · GitHub
Skip to content
[Spring] Fix template for RequestBody, added 'required' attribute#4756

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

wing328
merged 2 commits into

from

Dec 16, 2019
 Merged


[Spring] Fix template for RequestBody, added 'required' attribute
#4756
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
2db9379

fix template for RequestBody, added 'required' attribute (#3134)


ahrytsiuk Dec 10, 2019
8e40a63

update Spring samples (#3134)


ahrytsiuk Dec 10, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
modules/openapi-generator/src/main/resources/JavaSpring/bodyParams.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
{{#isBodyParam}}@ApiParam(value = "{{{description}}}" {{#required}},required=true{{/required}} {{^isContainer}}{{#allowableValues}}, allowableValues="{{{allowableValues}}}"{{/allowableValues}}{{#defaultValue}}, defaultValue={{^isString}}"{{/isString}}{{#isString}}{{#isEnum}}"{{/isEnum}}{{/isString}}{{{defaultValue}}}{{^isString}}"{{/isString}}{{#isString}}{{#isEnum}}"{{/isEnum}}{{/isString}}{{/defaultValue}}{{/isContainer}}) {{#useBeanValidation}}@Valid{{/useBeanValidation}} @RequestBody {{^reactive}}{{{dataType}}}{{/reactive}}{{#reactive}}{{^isListContainer}}Mono{{/isListContainer}}{{#isListContainer}}Flux{{/isListContainer}}<{{{baseType}}}>{{/reactive}} {{paramName}}{{/isBodyParam}}
{{#isBodyParam}}@ApiParam(value = "{{{description}}}" {{#required}},required=true{{/required}} {{^isContainer}}{{#allowableValues}}, allowableValues="{{{allowableValues}}}"{{/allowableValues}}{{#defaultValue}}, defaultValue={{^isString}}"{{/isString}}{{#isString}}{{#isEnum}}"{{/isEnum}}{{/isString}}{{{defaultValue}}}{{^isString}}"{{/isString}}{{#isString}}{{#isEnum}}"{{/isEnum}}{{/isString}}{{/defaultValue}}{{/isContainer}}) {{#useBeanValidation}}@Valid{{/useBeanValidation}} @RequestBody{{^required}}(required = false){{/required}} {{^reactive}}{{{dataType}}}{{/reactive}}{{#reactive}}{{^isListContainer}}Mono{{/isListContainer}}{{#isListContainer}}Flux{{/isListContainer}}<{{{baseType}}}>{{/reactive}} {{paramName}}{{/isBodyParam}}

24 changes: 24 additions & 0 deletions
...enapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -416,4 +416,28 @@ public void reactiveRequiredSpringBoot() {
 codegen.additionalProperties().put(CodegenConstants.LIBRARY, "spring-cloud");
 codegen.processOpts();
 }

 @Test
 public void testDoGenerateRequestBodyRequiredAttribute_3134_Regression() throws Exception {
 File output = Files.createTempDirectory("test").toFile().getCanonicalFile();
 output.deleteOnExit();
 String outputPath = output.getAbsolutePath().replace('\\', '/');

 OpenAPI openAPI = new OpenAPIParser()
 .readLocation("src/test/resources/3_0/3134-regression.yaml", null, new ParseOptions()).getOpenAPI();

 SpringCodegen codegen = new SpringCodegen();
 codegen.setOutputDir(output.getAbsolutePath());
 codegen.additionalProperties().put(CXFServerFeatures.LOAD_TEST_DATA_FROM_FILE, "true");

 ClientOptInput input = new ClientOptInput();
 input.setOpenAPI(openAPI);
 input.setConfig(codegen);

 MockDefaultGenerator generator = new MockDefaultGenerator();
 generator.opts(input).generate();

 checkFileContains(generator, outputPath + "/src/main/java/org/openapitools/api/ExampleApi.java",
 "@RequestBody(required = false");
 }
}

23 changes: 23 additions & 0 deletions
modules/openapi-generator/src/test/resources/3_0/3134-regression.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
openapi: 3.0.2
info:
 title: info
 description: info
 version: 0.1.0

paths:
 /example/api:
 post:
 summary: summary
 description: description
 requestBody:
 required: false
 content:
 application/json:
 schema:
 type: object
 properties:
 name:
 type: string
 responses:
 200:
 description: response

8 changes: 4 additions & 4 deletions
samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/api/FakeApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -78,7 +78,7 @@ default CompletableFuture<ResponseEntity<Void>> createXmlItem(@ApiParam(value =
 @RequestMapping(value = "/fake/outer/boolean",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default CompletableFuture<ResponseEntity<Boolean>> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) {
 default CompletableFuture<ResponseEntity<Boolean>> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body) {
 return CompletableFuture.completedFuture(new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED));

 }
Expand All@@ -97,7 +97,7 @@ default CompletableFuture<ResponseEntity<Boolean>> fakeOuterBooleanSerialize(@Ap
 @RequestMapping(value = "/fake/outer/composite",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default CompletableFuture<ResponseEntity<OuterComposite>> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) {
 default CompletableFuture<ResponseEntity<OuterComposite>> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body) {
 return CompletableFuture.supplyAsync(()-> {
 getRequest().ifPresent(request -> {
 for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
Expand DownExpand Up@@ -127,7 +127,7 @@ default CompletableFuture<ResponseEntity<OuterComposite>> fakeOuterCompositeSeri
 @RequestMapping(value = "/fake/outer/number",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default CompletableFuture<ResponseEntity<BigDecimal>> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) {
 default CompletableFuture<ResponseEntity<BigDecimal>> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body) {
 return CompletableFuture.completedFuture(new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED));

 }
Expand All@@ -146,7 +146,7 @@ default CompletableFuture<ResponseEntity<BigDecimal>> fakeOuterNumberSerialize(@
 @RequestMapping(value = "/fake/outer/string",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default CompletableFuture<ResponseEntity<String>> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) {
 default CompletableFuture<ResponseEntity<String>> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body) {
 return CompletableFuture.completedFuture(new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED));

 }
Expand Down

8 changes: 4 additions & 4 deletions
...rver/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/api/FakeApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -77,7 +77,7 @@ default ResponseEntity<Void> createXmlItem(@ApiParam(value = "XmlItem Body" ,req
 @RequestMapping(value = "/fake/outer/boolean",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) {
 default ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand All@@ -96,7 +96,7 @@ default ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Inp
 @RequestMapping(value = "/fake/outer/composite",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) {
 default ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body) {
 getRequest().ifPresent(request -> {
 for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
 if (mediaType.isCompatibleWith(MediaType.valueOf("*/*"))) {
Expand DownExpand Up@@ -124,7 +124,7 @@ default ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(val
 @RequestMapping(value = "/fake/outer/number",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) {
 default ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand All@@ -143,7 +143,7 @@ default ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "I
 @RequestMapping(value = "/fake/outer/string",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) {
 default ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand Down

8 changes: 4 additions & 4 deletions
samples/server/petstore/spring-mvc/src/main/java/org/openapitools/api/FakeApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -66,7 +66,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/boolean",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body);
 ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body);


 /**
Expand All@@ -82,7 +82,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/composite",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body);
 ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body);


 /**
Expand All@@ -98,7 +98,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/number",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body);
 ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body);


 /**
Expand All@@ -114,7 +114,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/string",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body);
 ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body);


 /**
Expand Down

8 changes: 4 additions & 4 deletions
samples/server/petstore/spring-mvc/src/main/java/org/openapitools/api/FakeApiController.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,7 +62,7 @@ public ResponseEntity<Void> createXmlItem(@ApiParam(value = "XmlItem Body" ,requ
 * @return Output boolean (status code 200)
 * @see FakeApi#fakeOuterBooleanSerialize
 */
 public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) {
 public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand All@@ -75,7 +75,7 @@ public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Inpu
 * @return Output composite (status code 200)
 * @see FakeApi#fakeOuterCompositeSerialize
 */
 public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) {
 public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body) {
 for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
 if (mediaType.isCompatibleWith(MediaType.valueOf("*/*"))) {
 String exampleString = "{ \"my_string\" : \"my_string\", \"my_number\" : 0.8008281904610115, \"my_boolean\" : true }";
Expand All@@ -95,7 +95,7 @@ public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(valu
 * @return Output number (status code 200)
 * @see FakeApi#fakeOuterNumberSerialize
 */
 public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) {
 public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand All@@ -108,7 +108,7 @@ public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "In
 * @return Output string (status code 200)
 * @see FakeApi#fakeOuterStringSerialize
 */
 public ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) {
 public ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand Down

8 changes: 4 additions & 4 deletions
...server/petstore/springboot-beanvalidation/src/main/java/org/openapitools/api/FakeApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -66,7 +66,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/boolean",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body);
 ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body);


 /**
Expand All@@ -82,7 +82,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/composite",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body);
 ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body);


 /**
Expand All@@ -98,7 +98,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/number",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body);
 ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body);


 /**
Expand All@@ -114,7 +114,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/string",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body);
 ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body);


 /**
Expand Down

8 changes: 4 additions & 4 deletions
...store/springboot-beanvalidation/src/main/java/org/openapitools/api/FakeApiController.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,7 +62,7 @@ public ResponseEntity<Void> createXmlItem(@ApiParam(value = "XmlItem Body" ,requ
 * @return Output boolean (status code 200)
 * @see FakeApi#fakeOuterBooleanSerialize
 */
 public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) {
 public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand All@@ -75,7 +75,7 @@ public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Inpu
 * @return Output composite (status code 200)
 * @see FakeApi#fakeOuterCompositeSerialize
 */
 public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) {
 public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body) {
 for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
 if (mediaType.isCompatibleWith(MediaType.valueOf("*/*"))) {
 String exampleString = "{ \"my_string\" : \"my_string\", \"my_number\" : 0.8008281904610115, \"my_boolean\" : true }";
Expand All@@ -95,7 +95,7 @@ public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(valu
 * @return Output number (status code 200)
 * @see FakeApi#fakeOuterNumberSerialize
 */
 public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) {
 public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand All@@ -108,7 +108,7 @@ public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "In
 * @return Output string (status code 200)
 * @see FakeApi#fakeOuterStringSerialize
 */
 public ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) {
 public ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[Spring] Fix template for RequestBody, added 'required' attribute by ahrytsiuk · Pull Request #4756 · OpenAPITools/openapi-generator · GitHub
Skip to content
[Spring] Fix template for RequestBody, added 'required' attribute#4756

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

wing328
merged 2 commits into

from

Dec 16, 2019
 Merged


[Spring] Fix template for RequestBody, added 'required' attribute
#4756
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
2db9379

fix template for RequestBody, added 'required' attribute (#3134)


ahrytsiuk Dec 10, 2019
8e40a63

update Spring samples (#3134)


ahrytsiuk Dec 10, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
modules/openapi-generator/src/main/resources/JavaSpring/bodyParams.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
{{#isBodyParam}}@ApiParam(value = "{{{description}}}" {{#required}},required=true{{/required}} {{^isContainer}}{{#allowableValues}}, allowableValues="{{{allowableValues}}}"{{/allowableValues}}{{#defaultValue}}, defaultValue={{^isString}}"{{/isString}}{{#isString}}{{#isEnum}}"{{/isEnum}}{{/isString}}{{{defaultValue}}}{{^isString}}"{{/isString}}{{#isString}}{{#isEnum}}"{{/isEnum}}{{/isString}}{{/defaultValue}}{{/isContainer}}) {{#useBeanValidation}}@Valid{{/useBeanValidation}} @RequestBody {{^reactive}}{{{dataType}}}{{/reactive}}{{#reactive}}{{^isListContainer}}Mono{{/isListContainer}}{{#isListContainer}}Flux{{/isListContainer}}<{{{baseType}}}>{{/reactive}} {{paramName}}{{/isBodyParam}}
{{#isBodyParam}}@ApiParam(value = "{{{description}}}" {{#required}},required=true{{/required}} {{^isContainer}}{{#allowableValues}}, allowableValues="{{{allowableValues}}}"{{/allowableValues}}{{#defaultValue}}, defaultValue={{^isString}}"{{/isString}}{{#isString}}{{#isEnum}}"{{/isEnum}}{{/isString}}{{{defaultValue}}}{{^isString}}"{{/isString}}{{#isString}}{{#isEnum}}"{{/isEnum}}{{/isString}}{{/defaultValue}}{{/isContainer}}) {{#useBeanValidation}}@Valid{{/useBeanValidation}} @RequestBody{{^required}}(required = false){{/required}} {{^reactive}}{{{dataType}}}{{/reactive}}{{#reactive}}{{^isListContainer}}Mono{{/isListContainer}}{{#isListContainer}}Flux{{/isListContainer}}<{{{baseType}}}>{{/reactive}} {{paramName}}{{/isBodyParam}}

24 changes: 24 additions & 0 deletions
...enapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -416,4 +416,28 @@ public void reactiveRequiredSpringBoot() {
 codegen.additionalProperties().put(CodegenConstants.LIBRARY, "spring-cloud");
 codegen.processOpts();
 }

 @Test
 public void testDoGenerateRequestBodyRequiredAttribute_3134_Regression() throws Exception {
 File output = Files.createTempDirectory("test").toFile().getCanonicalFile();
 output.deleteOnExit();
 String outputPath = output.getAbsolutePath().replace('\\', '/');

 OpenAPI openAPI = new OpenAPIParser()
 .readLocation("src/test/resources/3_0/3134-regression.yaml", null, new ParseOptions()).getOpenAPI();

 SpringCodegen codegen = new SpringCodegen();
 codegen.setOutputDir(output.getAbsolutePath());
 codegen.additionalProperties().put(CXFServerFeatures.LOAD_TEST_DATA_FROM_FILE, "true");

 ClientOptInput input = new ClientOptInput();
 input.setOpenAPI(openAPI);
 input.setConfig(codegen);

 MockDefaultGenerator generator = new MockDefaultGenerator();
 generator.opts(input).generate();

 checkFileContains(generator, outputPath + "/src/main/java/org/openapitools/api/ExampleApi.java",
 "@RequestBody(required = false");
 }
}

23 changes: 23 additions & 0 deletions
modules/openapi-generator/src/test/resources/3_0/3134-regression.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
openapi: 3.0.2
info:
 title: info
 description: info
 version: 0.1.0

paths:
 /example/api:
 post:
 summary: summary
 description: description
 requestBody:
 required: false
 content:
 application/json:
 schema:
 type: object
 properties:
 name:
 type: string
 responses:
 200:
 description: response

8 changes: 4 additions & 4 deletions
samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/api/FakeApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -78,7 +78,7 @@ default CompletableFuture<ResponseEntity<Void>> createXmlItem(@ApiParam(value =
 @RequestMapping(value = "/fake/outer/boolean",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default CompletableFuture<ResponseEntity<Boolean>> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) {
 default CompletableFuture<ResponseEntity<Boolean>> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body) {
 return CompletableFuture.completedFuture(new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED));

 }
Expand All@@ -97,7 +97,7 @@ default CompletableFuture<ResponseEntity<Boolean>> fakeOuterBooleanSerialize(@Ap
 @RequestMapping(value = "/fake/outer/composite",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default CompletableFuture<ResponseEntity<OuterComposite>> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) {
 default CompletableFuture<ResponseEntity<OuterComposite>> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body) {
 return CompletableFuture.supplyAsync(()-> {
 getRequest().ifPresent(request -> {
 for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
Expand DownExpand Up@@ -127,7 +127,7 @@ default CompletableFuture<ResponseEntity<OuterComposite>> fakeOuterCompositeSeri
 @RequestMapping(value = "/fake/outer/number",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default CompletableFuture<ResponseEntity<BigDecimal>> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) {
 default CompletableFuture<ResponseEntity<BigDecimal>> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body) {
 return CompletableFuture.completedFuture(new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED));

 }
Expand All@@ -146,7 +146,7 @@ default CompletableFuture<ResponseEntity<BigDecimal>> fakeOuterNumberSerialize(@
 @RequestMapping(value = "/fake/outer/string",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default CompletableFuture<ResponseEntity<String>> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) {
 default CompletableFuture<ResponseEntity<String>> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body) {
 return CompletableFuture.completedFuture(new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED));

 }
Expand Down

8 changes: 4 additions & 4 deletions
...rver/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/api/FakeApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -77,7 +77,7 @@ default ResponseEntity<Void> createXmlItem(@ApiParam(value = "XmlItem Body" ,req
 @RequestMapping(value = "/fake/outer/boolean",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) {
 default ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand All@@ -96,7 +96,7 @@ default ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Inp
 @RequestMapping(value = "/fake/outer/composite",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) {
 default ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body) {
 getRequest().ifPresent(request -> {
 for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
 if (mediaType.isCompatibleWith(MediaType.valueOf("*/*"))) {
Expand DownExpand Up@@ -124,7 +124,7 @@ default ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(val
 @RequestMapping(value = "/fake/outer/number",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) {
 default ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand All@@ -143,7 +143,7 @@ default ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "I
 @RequestMapping(value = "/fake/outer/string",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) {
 default ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand Down

8 changes: 4 additions & 4 deletions
samples/server/petstore/spring-mvc/src/main/java/org/openapitools/api/FakeApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -66,7 +66,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/boolean",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body);
 ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body);


 /**
Expand All@@ -82,7 +82,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/composite",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body);
 ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body);


 /**
Expand All@@ -98,7 +98,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/number",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body);
 ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body);


 /**
Expand All@@ -114,7 +114,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/string",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body);
 ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body);


 /**
Expand Down

8 changes: 4 additions & 4 deletions
samples/server/petstore/spring-mvc/src/main/java/org/openapitools/api/FakeApiController.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,7 +62,7 @@ public ResponseEntity<Void> createXmlItem(@ApiParam(value = "XmlItem Body" ,requ
 * @return Output boolean (status code 200)
 * @see FakeApi#fakeOuterBooleanSerialize
 */
 public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) {
 public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand All@@ -75,7 +75,7 @@ public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Inpu
 * @return Output composite (status code 200)
 * @see FakeApi#fakeOuterCompositeSerialize
 */
 public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) {
 public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body) {
 for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
 if (mediaType.isCompatibleWith(MediaType.valueOf("*/*"))) {
 String exampleString = "{ \"my_string\" : \"my_string\", \"my_number\" : 0.8008281904610115, \"my_boolean\" : true }";
Expand All@@ -95,7 +95,7 @@ public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(valu
 * @return Output number (status code 200)
 * @see FakeApi#fakeOuterNumberSerialize
 */
 public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) {
 public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand All@@ -108,7 +108,7 @@ public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "In
 * @return Output string (status code 200)
 * @see FakeApi#fakeOuterStringSerialize
 */
 public ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) {
 public ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand Down

8 changes: 4 additions & 4 deletions
...server/petstore/springboot-beanvalidation/src/main/java/org/openapitools/api/FakeApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -66,7 +66,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/boolean",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body);
 ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body);


 /**
Expand All@@ -82,7 +82,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/composite",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body);
 ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body);


 /**
Expand All@@ -98,7 +98,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/number",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body);
 ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body);


 /**
Expand All@@ -114,7 +114,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/string",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body);
 ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body);


 /**
Expand Down

8 changes: 4 additions & 4 deletions
...store/springboot-beanvalidation/src/main/java/org/openapitools/api/FakeApiController.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,7 +62,7 @@ public ResponseEntity<Void> createXmlItem(@ApiParam(value = "XmlItem Body" ,requ
 * @return Output boolean (status code 200)
 * @see FakeApi#fakeOuterBooleanSerialize
 */
 public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) {
 public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand All@@ -75,7 +75,7 @@ public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Inpu
 * @return Output composite (status code 200)
 * @see FakeApi#fakeOuterCompositeSerialize
 */
 public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) {
 public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body) {
 for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
 if (mediaType.isCompatibleWith(MediaType.valueOf("*/*"))) {
 String exampleString = "{ \"my_string\" : \"my_string\", \"my_number\" : 0.8008281904610115, \"my_boolean\" : true }";
Expand All@@ -95,7 +95,7 @@ public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(valu
 * @return Output number (status code 200)
 * @see FakeApi#fakeOuterNumberSerialize
 */
 public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) {
 public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand All@@ -108,7 +108,7 @@ public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "In
 * @return Output string (status code 200)
 * @see FakeApi#fakeOuterStringSerialize
 */
 public ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) {
 public ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
[Spring] Fix template for RequestBody, added 'required' attribute by ahrytsiuk · Pull Request #4756 · OpenAPITools/openapi-generator · GitHub
Skip to content
[Spring] Fix template for RequestBody, added 'required' attribute#4756

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

wing328
merged 2 commits into

from

Dec 16, 2019
 Merged


[Spring] Fix template for RequestBody, added 'required' attribute
#4756
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
2db9379

fix template for RequestBody, added 'required' attribute (#3134)


ahrytsiuk Dec 10, 2019
8e40a63

update Spring samples (#3134)


ahrytsiuk Dec 10, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
modules/openapi-generator/src/main/resources/JavaSpring/bodyParams.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
{{#isBodyParam}}@ApiParam(value = "{{{description}}}" {{#required}},required=true{{/required}} {{^isContainer}}{{#allowableValues}}, allowableValues="{{{allowableValues}}}"{{/allowableValues}}{{#defaultValue}}, defaultValue={{^isString}}"{{/isString}}{{#isString}}{{#isEnum}}"{{/isEnum}}{{/isString}}{{{defaultValue}}}{{^isString}}"{{/isString}}{{#isString}}{{#isEnum}}"{{/isEnum}}{{/isString}}{{/defaultValue}}{{/isContainer}}) {{#useBeanValidation}}@Valid{{/useBeanValidation}} @RequestBody {{^reactive}}{{{dataType}}}{{/reactive}}{{#reactive}}{{^isListContainer}}Mono{{/isListContainer}}{{#isListContainer}}Flux{{/isListContainer}}<{{{baseType}}}>{{/reactive}} {{paramName}}{{/isBodyParam}}
{{#isBodyParam}}@ApiParam(value = "{{{description}}}" {{#required}},required=true{{/required}} {{^isContainer}}{{#allowableValues}}, allowableValues="{{{allowableValues}}}"{{/allowableValues}}{{#defaultValue}}, defaultValue={{^isString}}"{{/isString}}{{#isString}}{{#isEnum}}"{{/isEnum}}{{/isString}}{{{defaultValue}}}{{^isString}}"{{/isString}}{{#isString}}{{#isEnum}}"{{/isEnum}}{{/isString}}{{/defaultValue}}{{/isContainer}}) {{#useBeanValidation}}@Valid{{/useBeanValidation}} @RequestBody{{^required}}(required = false){{/required}} {{^reactive}}{{{dataType}}}{{/reactive}}{{#reactive}}{{^isListContainer}}Mono{{/isListContainer}}{{#isListContainer}}Flux{{/isListContainer}}<{{{baseType}}}>{{/reactive}} {{paramName}}{{/isBodyParam}}

24 changes: 24 additions & 0 deletions
...enapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -416,4 +416,28 @@ public void reactiveRequiredSpringBoot() {
 codegen.additionalProperties().put(CodegenConstants.LIBRARY, "spring-cloud");
 codegen.processOpts();
 }

 @Test
 public void testDoGenerateRequestBodyRequiredAttribute_3134_Regression() throws Exception {
 File output = Files.createTempDirectory("test").toFile().getCanonicalFile();
 output.deleteOnExit();
 String outputPath = output.getAbsolutePath().replace('\\', '/');

 OpenAPI openAPI = new OpenAPIParser()
 .readLocation("src/test/resources/3_0/3134-regression.yaml", null, new ParseOptions()).getOpenAPI();

 SpringCodegen codegen = new SpringCodegen();
 codegen.setOutputDir(output.getAbsolutePath());
 codegen.additionalProperties().put(CXFServerFeatures.LOAD_TEST_DATA_FROM_FILE, "true");

 ClientOptInput input = new ClientOptInput();
 input.setOpenAPI(openAPI);
 input.setConfig(codegen);

 MockDefaultGenerator generator = new MockDefaultGenerator();
 generator.opts(input).generate();

 checkFileContains(generator, outputPath + "/src/main/java/org/openapitools/api/ExampleApi.java",
 "@RequestBody(required = false");
 }
}

23 changes: 23 additions & 0 deletions
modules/openapi-generator/src/test/resources/3_0/3134-regression.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
openapi: 3.0.2
info:
 title: info
 description: info
 version: 0.1.0

paths:
 /example/api:
 post:
 summary: summary
 description: description
 requestBody:
 required: false
 content:
 application/json:
 schema:
 type: object
 properties:
 name:
 type: string
 responses:
 200:
 description: response

8 changes: 4 additions & 4 deletions
samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/api/FakeApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -78,7 +78,7 @@ default CompletableFuture<ResponseEntity<Void>> createXmlItem(@ApiParam(value =
 @RequestMapping(value = "/fake/outer/boolean",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default CompletableFuture<ResponseEntity<Boolean>> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) {
 default CompletableFuture<ResponseEntity<Boolean>> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body) {
 return CompletableFuture.completedFuture(new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED));

 }
Expand All@@ -97,7 +97,7 @@ default CompletableFuture<ResponseEntity<Boolean>> fakeOuterBooleanSerialize(@Ap
 @RequestMapping(value = "/fake/outer/composite",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default CompletableFuture<ResponseEntity<OuterComposite>> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) {
 default CompletableFuture<ResponseEntity<OuterComposite>> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body) {
 return CompletableFuture.supplyAsync(()-> {
 getRequest().ifPresent(request -> {
 for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
Expand DownExpand Up@@ -127,7 +127,7 @@ default CompletableFuture<ResponseEntity<OuterComposite>> fakeOuterCompositeSeri
 @RequestMapping(value = "/fake/outer/number",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default CompletableFuture<ResponseEntity<BigDecimal>> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) {
 default CompletableFuture<ResponseEntity<BigDecimal>> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body) {
 return CompletableFuture.completedFuture(new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED));

 }
Expand All@@ -146,7 +146,7 @@ default CompletableFuture<ResponseEntity<BigDecimal>> fakeOuterNumberSerialize(@
 @RequestMapping(value = "/fake/outer/string",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default CompletableFuture<ResponseEntity<String>> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) {
 default CompletableFuture<ResponseEntity<String>> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body) {
 return CompletableFuture.completedFuture(new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED));

 }
Expand Down

8 changes: 4 additions & 4 deletions
...rver/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/api/FakeApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -77,7 +77,7 @@ default ResponseEntity<Void> createXmlItem(@ApiParam(value = "XmlItem Body" ,req
 @RequestMapping(value = "/fake/outer/boolean",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) {
 default ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand All@@ -96,7 +96,7 @@ default ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Inp
 @RequestMapping(value = "/fake/outer/composite",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) {
 default ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body) {
 getRequest().ifPresent(request -> {
 for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
 if (mediaType.isCompatibleWith(MediaType.valueOf("*/*"))) {
Expand DownExpand Up@@ -124,7 +124,7 @@ default ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(val
 @RequestMapping(value = "/fake/outer/number",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) {
 default ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand All@@ -143,7 +143,7 @@ default ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "I
 @RequestMapping(value = "/fake/outer/string",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) {
 default ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand Down

8 changes: 4 additions & 4 deletions
samples/server/petstore/spring-mvc/src/main/java/org/openapitools/api/FakeApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -66,7 +66,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/boolean",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body);
 ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body);


 /**
Expand All@@ -82,7 +82,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/composite",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body);
 ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body);


 /**
Expand All@@ -98,7 +98,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/number",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body);
 ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body);


 /**
Expand All@@ -114,7 +114,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/string",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body);
 ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body);


 /**
Expand Down

8 changes: 4 additions & 4 deletions
samples/server/petstore/spring-mvc/src/main/java/org/openapitools/api/FakeApiController.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,7 +62,7 @@ public ResponseEntity<Void> createXmlItem(@ApiParam(value = "XmlItem Body" ,requ
 * @return Output boolean (status code 200)
 * @see FakeApi#fakeOuterBooleanSerialize
 */
 public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) {
 public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand All@@ -75,7 +75,7 @@ public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Inpu
 * @return Output composite (status code 200)
 * @see FakeApi#fakeOuterCompositeSerialize
 */
 public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) {
 public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body) {
 for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
 if (mediaType.isCompatibleWith(MediaType.valueOf("*/*"))) {
 String exampleString = "{ \"my_string\" : \"my_string\", \"my_number\" : 0.8008281904610115, \"my_boolean\" : true }";
Expand All@@ -95,7 +95,7 @@ public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(valu
 * @return Output number (status code 200)
 * @see FakeApi#fakeOuterNumberSerialize
 */
 public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) {
 public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand All@@ -108,7 +108,7 @@ public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "In
 * @return Output string (status code 200)
 * @see FakeApi#fakeOuterStringSerialize
 */
 public ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) {
 public ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand Down

8 changes: 4 additions & 4 deletions
...server/petstore/springboot-beanvalidation/src/main/java/org/openapitools/api/FakeApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -66,7 +66,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/boolean",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body);
 ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body);


 /**
Expand All@@ -82,7 +82,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/composite",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body);
 ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body);


 /**
Expand All@@ -98,7 +98,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/number",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body);
 ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body);


 /**
Expand All@@ -114,7 +114,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/string",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body);
 ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body);


 /**
Expand Down

8 changes: 4 additions & 4 deletions
...store/springboot-beanvalidation/src/main/java/org/openapitools/api/FakeApiController.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,7 +62,7 @@ public ResponseEntity<Void> createXmlItem(@ApiParam(value = "XmlItem Body" ,requ
 * @return Output boolean (status code 200)
 * @see FakeApi#fakeOuterBooleanSerialize
 */
 public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) {
 public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand All@@ -75,7 +75,7 @@ public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Inpu
 * @return Output composite (status code 200)
 * @see FakeApi#fakeOuterCompositeSerialize
 */
 public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) {
 public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body) {
 for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
 if (mediaType.isCompatibleWith(MediaType.valueOf("*/*"))) {
 String exampleString = "{ \"my_string\" : \"my_string\", \"my_number\" : 0.8008281904610115, \"my_boolean\" : true }";
Expand All@@ -95,7 +95,7 @@ public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(valu
 * @return Output number (status code 200)
 * @see FakeApi#fakeOuterNumberSerialize
 */
 public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) {
 public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand All@@ -108,7 +108,7 @@ public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "In
 * @return Output string (status code 200)
 * @see FakeApi#fakeOuterStringSerialize
 */
 public ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) {
 public ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[Spring] Fix template for RequestBody, added 'required' attribute by ahrytsiuk · Pull Request #4756 · OpenAPITools/openapi-generator · GitHub
Skip to content
[Spring] Fix template for RequestBody, added 'required' attribute#4756

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

wing328
merged 2 commits into

from

Dec 16, 2019
 Merged


[Spring] Fix template for RequestBody, added 'required' attribute
#4756
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
2db9379

fix template for RequestBody, added 'required' attribute (#3134)


ahrytsiuk Dec 10, 2019
8e40a63

update Spring samples (#3134)


ahrytsiuk Dec 10, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
modules/openapi-generator/src/main/resources/JavaSpring/bodyParams.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
{{#isBodyParam}}@ApiParam(value = "{{{description}}}" {{#required}},required=true{{/required}} {{^isContainer}}{{#allowableValues}}, allowableValues="{{{allowableValues}}}"{{/allowableValues}}{{#defaultValue}}, defaultValue={{^isString}}"{{/isString}}{{#isString}}{{#isEnum}}"{{/isEnum}}{{/isString}}{{{defaultValue}}}{{^isString}}"{{/isString}}{{#isString}}{{#isEnum}}"{{/isEnum}}{{/isString}}{{/defaultValue}}{{/isContainer}}) {{#useBeanValidation}}@Valid{{/useBeanValidation}} @RequestBody {{^reactive}}{{{dataType}}}{{/reactive}}{{#reactive}}{{^isListContainer}}Mono{{/isListContainer}}{{#isListContainer}}Flux{{/isListContainer}}<{{{baseType}}}>{{/reactive}} {{paramName}}{{/isBodyParam}}
{{#isBodyParam}}@ApiParam(value = "{{{description}}}" {{#required}},required=true{{/required}} {{^isContainer}}{{#allowableValues}}, allowableValues="{{{allowableValues}}}"{{/allowableValues}}{{#defaultValue}}, defaultValue={{^isString}}"{{/isString}}{{#isString}}{{#isEnum}}"{{/isEnum}}{{/isString}}{{{defaultValue}}}{{^isString}}"{{/isString}}{{#isString}}{{#isEnum}}"{{/isEnum}}{{/isString}}{{/defaultValue}}{{/isContainer}}) {{#useBeanValidation}}@Valid{{/useBeanValidation}} @RequestBody{{^required}}(required = false){{/required}} {{^reactive}}{{{dataType}}}{{/reactive}}{{#reactive}}{{^isListContainer}}Mono{{/isListContainer}}{{#isListContainer}}Flux{{/isListContainer}}<{{{baseType}}}>{{/reactive}} {{paramName}}{{/isBodyParam}}

24 changes: 24 additions & 0 deletions
...enapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -416,4 +416,28 @@ public void reactiveRequiredSpringBoot() {
 codegen.additionalProperties().put(CodegenConstants.LIBRARY, "spring-cloud");
 codegen.processOpts();
 }

 @Test
 public void testDoGenerateRequestBodyRequiredAttribute_3134_Regression() throws Exception {
 File output = Files.createTempDirectory("test").toFile().getCanonicalFile();
 output.deleteOnExit();
 String outputPath = output.getAbsolutePath().replace('\\', '/');

 OpenAPI openAPI = new OpenAPIParser()
 .readLocation("src/test/resources/3_0/3134-regression.yaml", null, new ParseOptions()).getOpenAPI();

 SpringCodegen codegen = new SpringCodegen();
 codegen.setOutputDir(output.getAbsolutePath());
 codegen.additionalProperties().put(CXFServerFeatures.LOAD_TEST_DATA_FROM_FILE, "true");

 ClientOptInput input = new ClientOptInput();
 input.setOpenAPI(openAPI);
 input.setConfig(codegen);

 MockDefaultGenerator generator = new MockDefaultGenerator();
 generator.opts(input).generate();

 checkFileContains(generator, outputPath + "/src/main/java/org/openapitools/api/ExampleApi.java",
 "@RequestBody(required = false");
 }
}

23 changes: 23 additions & 0 deletions
modules/openapi-generator/src/test/resources/3_0/3134-regression.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
openapi: 3.0.2
info:
 title: info
 description: info
 version: 0.1.0

paths:
 /example/api:
 post:
 summary: summary
 description: description
 requestBody:
 required: false
 content:
 application/json:
 schema:
 type: object
 properties:
 name:
 type: string
 responses:
 200:
 description: response

8 changes: 4 additions & 4 deletions
samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/api/FakeApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -78,7 +78,7 @@ default CompletableFuture<ResponseEntity<Void>> createXmlItem(@ApiParam(value =
 @RequestMapping(value = "/fake/outer/boolean",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default CompletableFuture<ResponseEntity<Boolean>> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) {
 default CompletableFuture<ResponseEntity<Boolean>> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body) {
 return CompletableFuture.completedFuture(new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED));

 }
Expand All@@ -97,7 +97,7 @@ default CompletableFuture<ResponseEntity<Boolean>> fakeOuterBooleanSerialize(@Ap
 @RequestMapping(value = "/fake/outer/composite",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default CompletableFuture<ResponseEntity<OuterComposite>> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) {
 default CompletableFuture<ResponseEntity<OuterComposite>> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body) {
 return CompletableFuture.supplyAsync(()-> {
 getRequest().ifPresent(request -> {
 for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
Expand DownExpand Up@@ -127,7 +127,7 @@ default CompletableFuture<ResponseEntity<OuterComposite>> fakeOuterCompositeSeri
 @RequestMapping(value = "/fake/outer/number",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default CompletableFuture<ResponseEntity<BigDecimal>> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) {
 default CompletableFuture<ResponseEntity<BigDecimal>> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body) {
 return CompletableFuture.completedFuture(new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED));

 }
Expand All@@ -146,7 +146,7 @@ default CompletableFuture<ResponseEntity<BigDecimal>> fakeOuterNumberSerialize(@
 @RequestMapping(value = "/fake/outer/string",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default CompletableFuture<ResponseEntity<String>> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) {
 default CompletableFuture<ResponseEntity<String>> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body) {
 return CompletableFuture.completedFuture(new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED));

 }
Expand Down

8 changes: 4 additions & 4 deletions
...rver/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/api/FakeApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -77,7 +77,7 @@ default ResponseEntity<Void> createXmlItem(@ApiParam(value = "XmlItem Body" ,req
 @RequestMapping(value = "/fake/outer/boolean",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) {
 default ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand All@@ -96,7 +96,7 @@ default ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Inp
 @RequestMapping(value = "/fake/outer/composite",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) {
 default ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body) {
 getRequest().ifPresent(request -> {
 for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
 if (mediaType.isCompatibleWith(MediaType.valueOf("*/*"))) {
Expand DownExpand Up@@ -124,7 +124,7 @@ default ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(val
 @RequestMapping(value = "/fake/outer/number",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) {
 default ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand All@@ -143,7 +143,7 @@ default ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "I
 @RequestMapping(value = "/fake/outer/string",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) {
 default ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand Down

8 changes: 4 additions & 4 deletions
samples/server/petstore/spring-mvc/src/main/java/org/openapitools/api/FakeApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -66,7 +66,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/boolean",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body);
 ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body);


 /**
Expand All@@ -82,7 +82,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/composite",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body);
 ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body);


 /**
Expand All@@ -98,7 +98,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/number",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body);
 ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body);


 /**
Expand All@@ -114,7 +114,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/string",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body);
 ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body);


 /**
Expand Down

8 changes: 4 additions & 4 deletions
samples/server/petstore/spring-mvc/src/main/java/org/openapitools/api/FakeApiController.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,7 +62,7 @@ public ResponseEntity<Void> createXmlItem(@ApiParam(value = "XmlItem Body" ,requ
 * @return Output boolean (status code 200)
 * @see FakeApi#fakeOuterBooleanSerialize
 */
 public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) {
 public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand All@@ -75,7 +75,7 @@ public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Inpu
 * @return Output composite (status code 200)
 * @see FakeApi#fakeOuterCompositeSerialize
 */
 public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) {
 public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body) {
 for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
 if (mediaType.isCompatibleWith(MediaType.valueOf("*/*"))) {
 String exampleString = "{ \"my_string\" : \"my_string\", \"my_number\" : 0.8008281904610115, \"my_boolean\" : true }";
Expand All@@ -95,7 +95,7 @@ public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(valu
 * @return Output number (status code 200)
 * @see FakeApi#fakeOuterNumberSerialize
 */
 public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) {
 public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand All@@ -108,7 +108,7 @@ public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "In
 * @return Output string (status code 200)
 * @see FakeApi#fakeOuterStringSerialize
 */
 public ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) {
 public ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand Down

8 changes: 4 additions & 4 deletions
...server/petstore/springboot-beanvalidation/src/main/java/org/openapitools/api/FakeApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -66,7 +66,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/boolean",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body);
 ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body);


 /**
Expand All@@ -82,7 +82,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/composite",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body);
 ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body);


 /**
Expand All@@ -98,7 +98,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/number",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body);
 ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body);


 /**
Expand All@@ -114,7 +114,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/string",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body);
 ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body);


 /**
Expand Down

8 changes: 4 additions & 4 deletions
...store/springboot-beanvalidation/src/main/java/org/openapitools/api/FakeApiController.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,7 +62,7 @@ public ResponseEntity<Void> createXmlItem(@ApiParam(value = "XmlItem Body" ,requ
 * @return Output boolean (status code 200)
 * @see FakeApi#fakeOuterBooleanSerialize
 */
 public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) {
 public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand All@@ -75,7 +75,7 @@ public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Inpu
 * @return Output composite (status code 200)
 * @see FakeApi#fakeOuterCompositeSerialize
 */
 public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) {
 public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body) {
 for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
 if (mediaType.isCompatibleWith(MediaType.valueOf("*/*"))) {
 String exampleString = "{ \"my_string\" : \"my_string\", \"my_number\" : 0.8008281904610115, \"my_boolean\" : true }";
Expand All@@ -95,7 +95,7 @@ public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(valu
 * @return Output number (status code 200)
 * @see FakeApi#fakeOuterNumberSerialize
 */
 public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) {
 public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand All@@ -108,7 +108,7 @@ public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "In
 * @return Output string (status code 200)
 * @see FakeApi#fakeOuterStringSerialize
 */
 public ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) {
 public ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[Spring] Fix template for RequestBody, added 'required' attribute by ahrytsiuk · Pull Request #4756 · OpenAPITools/openapi-generator · GitHub
Skip to content
[Spring] Fix template for RequestBody, added 'required' attribute#4756

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

wing328
merged 2 commits into

from

Dec 16, 2019
 Merged


[Spring] Fix template for RequestBody, added 'required' attribute
#4756
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
2db9379

fix template for RequestBody, added 'required' attribute (#3134)


ahrytsiuk Dec 10, 2019
8e40a63

update Spring samples (#3134)


ahrytsiuk Dec 10, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
modules/openapi-generator/src/main/resources/JavaSpring/bodyParams.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
{{#isBodyParam}}@ApiParam(value = "{{{description}}}" {{#required}},required=true{{/required}} {{^isContainer}}{{#allowableValues}}, allowableValues="{{{allowableValues}}}"{{/allowableValues}}{{#defaultValue}}, defaultValue={{^isString}}"{{/isString}}{{#isString}}{{#isEnum}}"{{/isEnum}}{{/isString}}{{{defaultValue}}}{{^isString}}"{{/isString}}{{#isString}}{{#isEnum}}"{{/isEnum}}{{/isString}}{{/defaultValue}}{{/isContainer}}) {{#useBeanValidation}}@Valid{{/useBeanValidation}} @RequestBody {{^reactive}}{{{dataType}}}{{/reactive}}{{#reactive}}{{^isListContainer}}Mono{{/isListContainer}}{{#isListContainer}}Flux{{/isListContainer}}<{{{baseType}}}>{{/reactive}} {{paramName}}{{/isBodyParam}}
{{#isBodyParam}}@ApiParam(value = "{{{description}}}" {{#required}},required=true{{/required}} {{^isContainer}}{{#allowableValues}}, allowableValues="{{{allowableValues}}}"{{/allowableValues}}{{#defaultValue}}, defaultValue={{^isString}}"{{/isString}}{{#isString}}{{#isEnum}}"{{/isEnum}}{{/isString}}{{{defaultValue}}}{{^isString}}"{{/isString}}{{#isString}}{{#isEnum}}"{{/isEnum}}{{/isString}}{{/defaultValue}}{{/isContainer}}) {{#useBeanValidation}}@Valid{{/useBeanValidation}} @RequestBody{{^required}}(required = false){{/required}} {{^reactive}}{{{dataType}}}{{/reactive}}{{#reactive}}{{^isListContainer}}Mono{{/isListContainer}}{{#isListContainer}}Flux{{/isListContainer}}<{{{baseType}}}>{{/reactive}} {{paramName}}{{/isBodyParam}}

24 changes: 24 additions & 0 deletions
...enapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -416,4 +416,28 @@ public void reactiveRequiredSpringBoot() {
 codegen.additionalProperties().put(CodegenConstants.LIBRARY, "spring-cloud");
 codegen.processOpts();
 }

 @Test
 public void testDoGenerateRequestBodyRequiredAttribute_3134_Regression() throws Exception {
 File output = Files.createTempDirectory("test").toFile().getCanonicalFile();
 output.deleteOnExit();
 String outputPath = output.getAbsolutePath().replace('\\', '/');

 OpenAPI openAPI = new OpenAPIParser()
 .readLocation("src/test/resources/3_0/3134-regression.yaml", null, new ParseOptions()).getOpenAPI();

 SpringCodegen codegen = new SpringCodegen();
 codegen.setOutputDir(output.getAbsolutePath());
 codegen.additionalProperties().put(CXFServerFeatures.LOAD_TEST_DATA_FROM_FILE, "true");

 ClientOptInput input = new ClientOptInput();
 input.setOpenAPI(openAPI);
 input.setConfig(codegen);

 MockDefaultGenerator generator = new MockDefaultGenerator();
 generator.opts(input).generate();

 checkFileContains(generator, outputPath + "/src/main/java/org/openapitools/api/ExampleApi.java",
 "@RequestBody(required = false");
 }
}

23 changes: 23 additions & 0 deletions
modules/openapi-generator/src/test/resources/3_0/3134-regression.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
openapi: 3.0.2
info:
 title: info
 description: info
 version: 0.1.0

paths:
 /example/api:
 post:
 summary: summary
 description: description
 requestBody:
 required: false
 content:
 application/json:
 schema:
 type: object
 properties:
 name:
 type: string
 responses:
 200:
 description: response

8 changes: 4 additions & 4 deletions
samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/api/FakeApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -78,7 +78,7 @@ default CompletableFuture<ResponseEntity<Void>> createXmlItem(@ApiParam(value =
 @RequestMapping(value = "/fake/outer/boolean",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default CompletableFuture<ResponseEntity<Boolean>> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) {
 default CompletableFuture<ResponseEntity<Boolean>> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body) {
 return CompletableFuture.completedFuture(new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED));

 }
Expand All@@ -97,7 +97,7 @@ default CompletableFuture<ResponseEntity<Boolean>> fakeOuterBooleanSerialize(@Ap
 @RequestMapping(value = "/fake/outer/composite",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default CompletableFuture<ResponseEntity<OuterComposite>> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) {
 default CompletableFuture<ResponseEntity<OuterComposite>> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body) {
 return CompletableFuture.supplyAsync(()-> {
 getRequest().ifPresent(request -> {
 for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
Expand DownExpand Up@@ -127,7 +127,7 @@ default CompletableFuture<ResponseEntity<OuterComposite>> fakeOuterCompositeSeri
 @RequestMapping(value = "/fake/outer/number",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default CompletableFuture<ResponseEntity<BigDecimal>> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) {
 default CompletableFuture<ResponseEntity<BigDecimal>> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body) {
 return CompletableFuture.completedFuture(new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED));

 }
Expand All@@ -146,7 +146,7 @@ default CompletableFuture<ResponseEntity<BigDecimal>> fakeOuterNumberSerialize(@
 @RequestMapping(value = "/fake/outer/string",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default CompletableFuture<ResponseEntity<String>> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) {
 default CompletableFuture<ResponseEntity<String>> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body) {
 return CompletableFuture.completedFuture(new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED));

 }
Expand Down

8 changes: 4 additions & 4 deletions
...rver/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/api/FakeApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -77,7 +77,7 @@ default ResponseEntity<Void> createXmlItem(@ApiParam(value = "XmlItem Body" ,req
 @RequestMapping(value = "/fake/outer/boolean",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) {
 default ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand All@@ -96,7 +96,7 @@ default ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Inp
 @RequestMapping(value = "/fake/outer/composite",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) {
 default ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body) {
 getRequest().ifPresent(request -> {
 for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
 if (mediaType.isCompatibleWith(MediaType.valueOf("*/*"))) {
Expand DownExpand Up@@ -124,7 +124,7 @@ default ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(val
 @RequestMapping(value = "/fake/outer/number",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) {
 default ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand All@@ -143,7 +143,7 @@ default ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "I
 @RequestMapping(value = "/fake/outer/string",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) {
 default ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand Down

8 changes: 4 additions & 4 deletions
samples/server/petstore/spring-mvc/src/main/java/org/openapitools/api/FakeApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -66,7 +66,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/boolean",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body);
 ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body);


 /**
Expand All@@ -82,7 +82,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/composite",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body);
 ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body);


 /**
Expand All@@ -98,7 +98,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/number",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body);
 ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body);


 /**
Expand All@@ -114,7 +114,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/string",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body);
 ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body);


 /**
Expand Down

8 changes: 4 additions & 4 deletions
samples/server/petstore/spring-mvc/src/main/java/org/openapitools/api/FakeApiController.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,7 +62,7 @@ public ResponseEntity<Void> createXmlItem(@ApiParam(value = "XmlItem Body" ,requ
 * @return Output boolean (status code 200)
 * @see FakeApi#fakeOuterBooleanSerialize
 */
 public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) {
 public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand All@@ -75,7 +75,7 @@ public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Inpu
 * @return Output composite (status code 200)
 * @see FakeApi#fakeOuterCompositeSerialize
 */
 public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) {
 public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body) {
 for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
 if (mediaType.isCompatibleWith(MediaType.valueOf("*/*"))) {
 String exampleString = "{ \"my_string\" : \"my_string\", \"my_number\" : 0.8008281904610115, \"my_boolean\" : true }";
Expand All@@ -95,7 +95,7 @@ public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(valu
 * @return Output number (status code 200)
 * @see FakeApi#fakeOuterNumberSerialize
 */
 public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) {
 public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand All@@ -108,7 +108,7 @@ public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "In
 * @return Output string (status code 200)
 * @see FakeApi#fakeOuterStringSerialize
 */
 public ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) {
 public ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand Down

8 changes: 4 additions & 4 deletions
...server/petstore/springboot-beanvalidation/src/main/java/org/openapitools/api/FakeApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -66,7 +66,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/boolean",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body);
 ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body);


 /**
Expand All@@ -82,7 +82,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/composite",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body);
 ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body);


 /**
Expand All@@ -98,7 +98,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/number",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body);
 ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body);


 /**
Expand All@@ -114,7 +114,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/string",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body);
 ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body);


 /**
Expand Down

8 changes: 4 additions & 4 deletions
...store/springboot-beanvalidation/src/main/java/org/openapitools/api/FakeApiController.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,7 +62,7 @@ public ResponseEntity<Void> createXmlItem(@ApiParam(value = "XmlItem Body" ,requ
 * @return Output boolean (status code 200)
 * @see FakeApi#fakeOuterBooleanSerialize
 */
 public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) {
 public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand All@@ -75,7 +75,7 @@ public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Inpu
 * @return Output composite (status code 200)
 * @see FakeApi#fakeOuterCompositeSerialize
 */
 public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) {
 public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body) {
 for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
 if (mediaType.isCompatibleWith(MediaType.valueOf("*/*"))) {
 String exampleString = "{ \"my_string\" : \"my_string\", \"my_number\" : 0.8008281904610115, \"my_boolean\" : true }";
Expand All@@ -95,7 +95,7 @@ public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(valu
 * @return Output number (status code 200)
 * @see FakeApi#fakeOuterNumberSerialize
 */
 public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) {
 public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand All@@ -108,7 +108,7 @@ public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "In
 * @return Output string (status code 200)
 * @see FakeApi#fakeOuterStringSerialize
 */
 public ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) {
 public ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
[Spring] Fix template for RequestBody, added 'required' attribute by ahrytsiuk · Pull Request #4756 · OpenAPITools/openapi-generator · GitHub
Skip to content
[Spring] Fix template for RequestBody, added 'required' attribute#4756

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

wing328
merged 2 commits into

from

Dec 16, 2019
 Merged


[Spring] Fix template for RequestBody, added 'required' attribute
#4756
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
2db9379

fix template for RequestBody, added 'required' attribute (#3134)


ahrytsiuk Dec 10, 2019
8e40a63

update Spring samples (#3134)


ahrytsiuk Dec 10, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
modules/openapi-generator/src/main/resources/JavaSpring/bodyParams.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
{{#isBodyParam}}@ApiParam(value = "{{{description}}}" {{#required}},required=true{{/required}} {{^isContainer}}{{#allowableValues}}, allowableValues="{{{allowableValues}}}"{{/allowableValues}}{{#defaultValue}}, defaultValue={{^isString}}"{{/isString}}{{#isString}}{{#isEnum}}"{{/isEnum}}{{/isString}}{{{defaultValue}}}{{^isString}}"{{/isString}}{{#isString}}{{#isEnum}}"{{/isEnum}}{{/isString}}{{/defaultValue}}{{/isContainer}}) {{#useBeanValidation}}@Valid{{/useBeanValidation}} @RequestBody {{^reactive}}{{{dataType}}}{{/reactive}}{{#reactive}}{{^isListContainer}}Mono{{/isListContainer}}{{#isListContainer}}Flux{{/isListContainer}}<{{{baseType}}}>{{/reactive}} {{paramName}}{{/isBodyParam}}
{{#isBodyParam}}@ApiParam(value = "{{{description}}}" {{#required}},required=true{{/required}} {{^isContainer}}{{#allowableValues}}, allowableValues="{{{allowableValues}}}"{{/allowableValues}}{{#defaultValue}}, defaultValue={{^isString}}"{{/isString}}{{#isString}}{{#isEnum}}"{{/isEnum}}{{/isString}}{{{defaultValue}}}{{^isString}}"{{/isString}}{{#isString}}{{#isEnum}}"{{/isEnum}}{{/isString}}{{/defaultValue}}{{/isContainer}}) {{#useBeanValidation}}@Valid{{/useBeanValidation}} @RequestBody{{^required}}(required = false){{/required}} {{^reactive}}{{{dataType}}}{{/reactive}}{{#reactive}}{{^isListContainer}}Mono{{/isListContainer}}{{#isListContainer}}Flux{{/isListContainer}}<{{{baseType}}}>{{/reactive}} {{paramName}}{{/isBodyParam}}

24 changes: 24 additions & 0 deletions
...enapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -416,4 +416,28 @@ public void reactiveRequiredSpringBoot() {
 codegen.additionalProperties().put(CodegenConstants.LIBRARY, "spring-cloud");
 codegen.processOpts();
 }

 @Test
 public void testDoGenerateRequestBodyRequiredAttribute_3134_Regression() throws Exception {
 File output = Files.createTempDirectory("test").toFile().getCanonicalFile();
 output.deleteOnExit();
 String outputPath = output.getAbsolutePath().replace('\\', '/');

 OpenAPI openAPI = new OpenAPIParser()
 .readLocation("src/test/resources/3_0/3134-regression.yaml", null, new ParseOptions()).getOpenAPI();

 SpringCodegen codegen = new SpringCodegen();
 codegen.setOutputDir(output.getAbsolutePath());
 codegen.additionalProperties().put(CXFServerFeatures.LOAD_TEST_DATA_FROM_FILE, "true");

 ClientOptInput input = new ClientOptInput();
 input.setOpenAPI(openAPI);
 input.setConfig(codegen);

 MockDefaultGenerator generator = new MockDefaultGenerator();
 generator.opts(input).generate();

 checkFileContains(generator, outputPath + "/src/main/java/org/openapitools/api/ExampleApi.java",
 "@RequestBody(required = false");
 }
}

23 changes: 23 additions & 0 deletions
modules/openapi-generator/src/test/resources/3_0/3134-regression.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
openapi: 3.0.2
info:
 title: info
 description: info
 version: 0.1.0

paths:
 /example/api:
 post:
 summary: summary
 description: description
 requestBody:
 required: false
 content:
 application/json:
 schema:
 type: object
 properties:
 name:
 type: string
 responses:
 200:
 description: response

8 changes: 4 additions & 4 deletions
samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/api/FakeApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -78,7 +78,7 @@ default CompletableFuture<ResponseEntity<Void>> createXmlItem(@ApiParam(value =
 @RequestMapping(value = "/fake/outer/boolean",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default CompletableFuture<ResponseEntity<Boolean>> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) {
 default CompletableFuture<ResponseEntity<Boolean>> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body) {
 return CompletableFuture.completedFuture(new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED));

 }
Expand All@@ -97,7 +97,7 @@ default CompletableFuture<ResponseEntity<Boolean>> fakeOuterBooleanSerialize(@Ap
 @RequestMapping(value = "/fake/outer/composite",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default CompletableFuture<ResponseEntity<OuterComposite>> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) {
 default CompletableFuture<ResponseEntity<OuterComposite>> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body) {
 return CompletableFuture.supplyAsync(()-> {
 getRequest().ifPresent(request -> {
 for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
Expand DownExpand Up@@ -127,7 +127,7 @@ default CompletableFuture<ResponseEntity<OuterComposite>> fakeOuterCompositeSeri
 @RequestMapping(value = "/fake/outer/number",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default CompletableFuture<ResponseEntity<BigDecimal>> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) {
 default CompletableFuture<ResponseEntity<BigDecimal>> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body) {
 return CompletableFuture.completedFuture(new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED));

 }
Expand All@@ -146,7 +146,7 @@ default CompletableFuture<ResponseEntity<BigDecimal>> fakeOuterNumberSerialize(@
 @RequestMapping(value = "/fake/outer/string",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default CompletableFuture<ResponseEntity<String>> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) {
 default CompletableFuture<ResponseEntity<String>> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body) {
 return CompletableFuture.completedFuture(new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED));

 }
Expand Down

8 changes: 4 additions & 4 deletions
...rver/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/api/FakeApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -77,7 +77,7 @@ default ResponseEntity<Void> createXmlItem(@ApiParam(value = "XmlItem Body" ,req
 @RequestMapping(value = "/fake/outer/boolean",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) {
 default ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand All@@ -96,7 +96,7 @@ default ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Inp
 @RequestMapping(value = "/fake/outer/composite",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) {
 default ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body) {
 getRequest().ifPresent(request -> {
 for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
 if (mediaType.isCompatibleWith(MediaType.valueOf("*/*"))) {
Expand DownExpand Up@@ -124,7 +124,7 @@ default ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(val
 @RequestMapping(value = "/fake/outer/number",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) {
 default ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand All@@ -143,7 +143,7 @@ default ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "I
 @RequestMapping(value = "/fake/outer/string",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 default ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) {
 default ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand Down

8 changes: 4 additions & 4 deletions
samples/server/petstore/spring-mvc/src/main/java/org/openapitools/api/FakeApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -66,7 +66,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/boolean",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body);
 ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body);


 /**
Expand All@@ -82,7 +82,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/composite",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body);
 ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body);


 /**
Expand All@@ -98,7 +98,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/number",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body);
 ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body);


 /**
Expand All@@ -114,7 +114,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/string",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body);
 ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body);


 /**
Expand Down

8 changes: 4 additions & 4 deletions
samples/server/petstore/spring-mvc/src/main/java/org/openapitools/api/FakeApiController.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,7 +62,7 @@ public ResponseEntity<Void> createXmlItem(@ApiParam(value = "XmlItem Body" ,requ
 * @return Output boolean (status code 200)
 * @see FakeApi#fakeOuterBooleanSerialize
 */
 public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) {
 public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand All@@ -75,7 +75,7 @@ public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Inpu
 * @return Output composite (status code 200)
 * @see FakeApi#fakeOuterCompositeSerialize
 */
 public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) {
 public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body) {
 for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
 if (mediaType.isCompatibleWith(MediaType.valueOf("*/*"))) {
 String exampleString = "{ \"my_string\" : \"my_string\", \"my_number\" : 0.8008281904610115, \"my_boolean\" : true }";
Expand All@@ -95,7 +95,7 @@ public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(valu
 * @return Output number (status code 200)
 * @see FakeApi#fakeOuterNumberSerialize
 */
 public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) {
 public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand All@@ -108,7 +108,7 @@ public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "In
 * @return Output string (status code 200)
 * @see FakeApi#fakeOuterStringSerialize
 */
 public ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) {
 public ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand Down

8 changes: 4 additions & 4 deletions
...server/petstore/springboot-beanvalidation/src/main/java/org/openapitools/api/FakeApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -66,7 +66,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/boolean",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body);
 ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body);


 /**
Expand All@@ -82,7 +82,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/composite",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body);
 ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body);


 /**
Expand All@@ -98,7 +98,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/number",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body);
 ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body);


 /**
Expand All@@ -114,7 +114,7 @@ public interface FakeApi {
 @RequestMapping(value = "/fake/outer/string",
 produces = { "*/*" }, 
 method = RequestMethod.POST)
 ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body);
 ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body);


 /**
Expand Down

8 changes: 4 additions & 4 deletions
...store/springboot-beanvalidation/src/main/java/org/openapitools/api/FakeApiController.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,7 +62,7 @@ public ResponseEntity<Void> createXmlItem(@ApiParam(value = "XmlItem Body" ,requ
 * @return Output boolean (status code 200)
 * @see FakeApi#fakeOuterBooleanSerialize
 */
 public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody Boolean body) {
 public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand All@@ -75,7 +75,7 @@ public ResponseEntity<Boolean> fakeOuterBooleanSerialize(@ApiParam(value = "Inpu
 * @return Output composite (status code 200)
 * @see FakeApi#fakeOuterCompositeSerialize
 */
 public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody OuterComposite body) {
 public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body) {
 for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
 if (mediaType.isCompatibleWith(MediaType.valueOf("*/*"))) {
 String exampleString = "{ \"my_string\" : \"my_string\", \"my_number\" : 0.8008281904610115, \"my_boolean\" : true }";
Expand All@@ -95,7 +95,7 @@ public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(@ApiParam(valu
 * @return Output number (status code 200)
 * @see FakeApi#fakeOuterNumberSerialize
 */
 public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody BigDecimal body) {
 public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand All@@ -108,7 +108,7 @@ public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(@ApiParam(value = "In
 * @return Output string (status code 200)
 * @see FakeApi#fakeOuterStringSerialize
 */
 public ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody String body) {
 public ResponseEntity<String> fakeOuterStringSerialize(@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body) {
 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

 }
Expand Down
Loading