Skip to content

[jaxrs-spec] Add builders to models#4916

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

Closed
shybovycha wants to merge 5 commits into from
Closed

[jaxrs-spec] Add builders to models #4916

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a9add69
Update formatting in jaxrs-spec POJOs
shybovycha Jan 2, 2020
0ee1f21
Add generateBuilders option
Jan 2, 2020
3d620c8
Update formatting in jaxrs-spec POJOs
shybovycha Jan 2, 2020
e41bf0d
Generate samples
Jan 2, 2020
ccb071f
Disable the builders generation by default
Jan 5, 2020
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
11 changes: 10 additions & 1 deletion ...enerator/src/main/java/org/openapitools/codegen/languages/JavaJAXRSSpecServerCodegen.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ public class JavaJAXRSSpecServerCodegen extends AbstractJavaJAXRSServerCodegen {
public static final String USE_SWAGGER_ANNOTATIONS = "useSwaggerAnnotations";
public static final String JACKSON = "jackson";
public static final String OPEN_API_SPEC_FILE_LOCATION = "openApiSpecFileLocation";
public static final String GENERATE_BUILDERS = "generateBuilders";

public static final String QUARKUS_LIBRARY = "quarkus";
public static final String THORNTAIL_LIBRARY = "thorntail";
Expand All@@ -51,6 +52,7 @@ public class JavaJAXRSSpecServerCodegen extends AbstractJavaJAXRSServerCodegen {
private boolean interfaceOnly = false;
private boolean returnResponse = false;
private boolean generatePom = true;
private boolean generateBuilders = false;
private boolean useSwaggerAnnotations = true;
private boolean useJackson = false;
private String openApiSpecFileLocation = "src/main/openapi/openapi.yaml";
Expand DownExpand Up@@ -102,6 +104,7 @@ public JavaJAXRSSpecServerCodegen() {

cliOptions.add(library);
cliOptions.add(CliOption.newBoolean(GENERATE_POM, "Whether to generate pom.xml if the file does not already exist.").defaultValue(String.valueOf(generatePom)));
cliOptions.add(CliOption.newBoolean(GENERATE_BUILDERS, "Whether to generate builders for models.").defaultValue(String.valueOf(generateBuilders)));
cliOptions.add(CliOption.newBoolean(INTERFACE_ONLY, "Whether to generate only API interface stubs without the server files.").defaultValue(String.valueOf(interfaceOnly)));
cliOptions.add(CliOption.newBoolean(RETURN_RESPONSE, "Whether generate API interface should return javax.ws.rs.core.Response instead of a deserialized entity. Only useful if interfaceOnly is true.").defaultValue(String.valueOf(returnResponse)));
cliOptions.add(CliOption.newBoolean(USE_SWAGGER_ANNOTATIONS, "Whether to generate Swagger annotations.", useSwaggerAnnotations));
Expand All@@ -125,14 +128,20 @@ public void processOpts() {
additionalProperties.remove(RETURN_RESPONSE);
}
}
if(QUARKUS_LIBRARY.equals(library) || THORNTAIL_LIBRARY.equals(library) || HELIDON_LIBRARY.equals(library) || OPEN_LIBERTY_LIBRARY.equals(library)) {
if(QUARKUS_LIBRARY.equals(library) || THORNTAIL_LIBRARY.equals(library) || HELIDON_LIBRARY.equals(library) || OPEN_LIBERTY_LIBRARY.equals(library)) {
useSwaggerAnnotations = false;
} else {
if (additionalProperties.containsKey(USE_SWAGGER_ANNOTATIONS)) {
useSwaggerAnnotations = Boolean.valueOf(additionalProperties.get(USE_SWAGGER_ANNOTATIONS).toString());
}
}
writePropertyBack(USE_SWAGGER_ANNOTATIONS, useSwaggerAnnotations);

if (additionalProperties.containsKey(GENERATE_BUILDERS)) {
generateBuilders = Boolean.valueOf(additionalProperties.get(GENERATE_BUILDERS).toString());
}
additionalProperties.put(GENERATE_BUILDERS, generateBuilders);

if (additionalProperties.containsKey(OPEN_API_SPEC_FILE_LOCATION)) {
openApiSpecFileLocation = additionalProperties.get(OPEN_API_SPEC_FILE_LOCATION).toString();
} else if(QUARKUS_LIBRARY.equals(library) || THORNTAIL_LIBRARY.equals(library) || HELIDON_LIBRARY.equals(library)) {
Expand Down
71 changes: 45 additions & 26 deletions modules/openapi-generator/src/main/resources/JavaJaxRS/spec/pojo.mustache
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,38 @@
{{#useSwaggerAnnotations}}
import io.swagger.annotations.*;
{{/useSwaggerAnnotations}}
{{#useSwaggerAnnotations}}import io.swagger.annotations.*;{{/useSwaggerAnnotations}}
Comment thread
shybovycha marked this conversation as resolved.
Outdated
import java.util.Objects;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;

{{#discriminator}}{{>typeInfoAnnotation}}{{/discriminator}}{{#description}}
/**
{{#discriminator}}{{>typeInfoAnnotation}}{{/discriminator}}{{#description}}/**
* {{description}}
**/{{/description}}{{#useSwaggerAnnotations}}
{{#description}}{{>additionalModelTypeAnnotations}}@ApiModel(description = "{{{description}}}"){{/description}}{{/useSwaggerAnnotations}}
**/{{/description}}
{{#useSwaggerAnnotations}}{{#description}}{{>additionalModelTypeAnnotations}}@ApiModel(description = "{{{description}}}"){{/description}}{{/useSwaggerAnnotations}}
public class {{classname}} {{#parent}}extends {{{parent}}}{{/parent}} {{#serializableModel}}implements Serializable{{/serializableModel}} {
{{#vars}}{{#isEnum}}{{^isContainer}}

{{>enumClass}}{{/isContainer}}{{#isContainer}}{{#mostInnerItems}}

{{>enumClass}}{{/mostInnerItems}}{{/isContainer}}{{/isEnum}}
private {{#useBeanValidation}}@Valid{{/useBeanValidation}}{{{datatypeWithEnum}}} {{name}}{{#defaultValue}} = {{{.}}}{{/defaultValue}};{{/vars}}
private {{#useBeanValidation}}@Valid{{/useBeanValidation}}{{{datatypeWithEnum}}} {{name}}{{#defaultValue}} = {{{.}}}{{/defaultValue}};{{/vars}}

{{#vars}}
/**
{{#description}}
* {{description}}
{{/description}}
{{#minimum}}
* minimum: {{minimum}}
{{/minimum}}
{{#maximum}}
* maximum: {{maximum}}
{{/maximum}}
**/
public {{classname}} {{name}}({{{datatypeWithEnum}}} {{name}}) {
{{#generateBuilders}}public {{classname}}({{#vars}}{{{datatypeWithEnum}}} {{name}}{{#hasMore}}, {{/hasMore}}{{/vars}}) {
{{#vars}}
this.{{name}} = {{name}};
return this;
{{/vars}}
}
{{/generateBuilders}}

{{#vendorExtensions.extraAnnotation}}{{{vendorExtensions.extraAnnotation}}}{{/vendorExtensions.extraAnnotation}}{{#useSwaggerAnnotations}}
{{#vars}}{{#vendorExtensions.extraAnnotation}}{{{vendorExtensions.extraAnnotation}}}{{/vendorExtensions.extraAnnotation}}{{#useSwaggerAnnotations}}
@ApiModelProperty({{#example}}example = "{{{example}}}", {{/example}}{{#required}}required = {{required}}, {{/required}}value = "{{{description}}}"){{/useSwaggerAnnotations}}
@JsonProperty("{{baseName}}")
{{#useBeanValidation}}{{>beanValidation}}{{/useBeanValidation}} public {{{datatypeWithEnum}}} {{getter}}() {
return {{name}};
}

public void {{setter}}({{{datatypeWithEnum}}} {{name}}) {
this.{{name}} = {{name}};
}

{{/vars}}
}{{/vars}}

@Override
public boolean equals(java.lang.Object o) {
Expand DownExpand Up@@ -88,4 +74,37 @@ public class {{classname}} {{#parent}}extends {{{parent}}}{{/parent}} {{#seriali
}
return o.toString().replace("\n", "\n ");
}

{{#generateBuilders}}
public static Builder builder() {
return new Builder();
}

public static class Builder {
{{#vars}}
private {{{datatypeWithEnum}}} {{name}}{{#defaultValue}} = {{{.}}}{{/defaultValue}};
{{/vars}}

{{#vars}}
/**
{{#description}}
* {{description}}
{{/description}}
{{#minimum}}
* minimum: {{minimum}}
{{/minimum}}
{{#maximum}}
* maximum: {{maximum}}
{{/maximum}}
**/
public Builder {{name}}({{{datatypeWithEnum}}} {{name}}) {
this.{{name}} = {{name}};
return this;
}
{{/vars}}

public {{classname}} build() {
return new {{classname}}({{#vars}}{{name}}{{#hasMore}}, {{/hasMore}}{{/vars}});
}
}{{/generateBuilders}}
}
2 changes: 1 addition & 1 deletion samples/server/petstore/jaxrs-spec-interface-response/.openapi-generator/VERSION
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
3.3.0-SNAPSHOT
4.3.0-SNAPSHOT
2 changes: 1 addition & 1 deletion ...store/jaxrs-spec-interface-response/src/gen/java/org/openapitools/api/AnotherFakeApi.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,5 +24,5 @@ public interface AnotherFakeApi {
@ApiOperation(value = "To test special tags", notes = "To test special tags and operation ID starting with number", tags={ "$another-fake?" })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation", response = Client.class) })
Response call123testSpecialTags(@Valid Client client);
Response call123testSpecialTags(@Valid Client body);
}
34 changes: 28 additions & 6 deletions ...ver/petstore/jaxrs-spec-interface-response/src/gen/java/org/openapitools/api/FakeApi.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@
import org.openapitools.model.ModelApiResponse;
import org.openapitools.model.OuterComposite;
import org.openapitools.model.User;
import org.openapitools.model.XmlItem;

import javax.ws.rs.*;
import javax.ws.rs.core.Response;
Expand All@@ -26,6 +27,14 @@
@Api(description = "the fake API")
public interface FakeApi {

@POST
@Path("/create_xml_item")
@Consumes({ "application/xml", "application/xml; charset=utf-8", "application/xml; charset=utf-16", "text/xml", "text/xml; charset=utf-8", "text/xml; charset=utf-16" })
@ApiOperation(value = "creates an XmlItem", notes = "this route creates an XmlItem", tags={ "fake", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation", response = Void.class) })
Response createXmlItem(@Valid XmlItem xmlItem);

@POST
@Path("/outer/boolean")
@Produces({ "*/*" })
Expand All@@ -40,7 +49,7 @@ public interface FakeApi {
@ApiOperation(value = "", notes = "Test serialization of object with outer number type", tags={ "fake", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "Output composite", response = OuterComposite.class) })
Response fakeOuterCompositeSerialize(@Valid OuterComposite outerComposite);
Response fakeOuterCompositeSerialize(@Valid OuterComposite body);

@POST
@Path("/outer/number")
Expand All@@ -64,23 +73,23 @@ public interface FakeApi {
@ApiOperation(value = "", notes = "For this test, the body for this request much reference a schema named `File`.", tags={ "fake", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "Success", response = Void.class) })
Response testBodyWithFileSchema(@Valid FileSchemaTestClass fileSchemaTestClass);
Response testBodyWithFileSchema(@Valid FileSchemaTestClass body);

@PUT
@Path("/body-with-query-params")
@Consumes({ "application/json" })
@ApiOperation(value = "", notes = "", tags={ "fake", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "Success", response = Void.class) })
Response testBodyWithQueryParams(@QueryParam("query") @NotNull String query,@Valid User user);
Response testBodyWithQueryParams(@QueryParam("query") @NotNull String query,@Valid User body);

@wing328wing328Jan 3, 2020

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I noticed that the body parameter name changes from user to body. Likely you're not using the latest (or recent) master when creating this PR.

Please merge the latest master of the official repo into your branch and regenerate the sample again.

@shybovychashybovychaJan 3, 2020

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have used 4.3.x as the origin of my branch, are you sure I should merge master in?

@wing328wing328Jan 3, 2020

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK. Please put it on hold. I'll take another look over the weekend or next week.


@PATCH
@Consumes({ "application/json" })
@Produces({ "application/json" })
@ApiOperation(value = "To test \"client\" model", notes = "To test \"client\" model", tags={ "fake", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation", response = Client.class) })
Response testClientModel(@Valid Client client);
Response testClientModel(@Valid Client body);

@POST
@Consumes({ "application/x-www-form-urlencoded" })
Expand All@@ -98,15 +107,21 @@ public interface FakeApi {
@ApiResponses(value = {
@ApiResponse(code = 400, message = "Invalid request", response = Void.class),
@ApiResponse(code = 404, message = "Not found", response = Void.class) })
Response testEnumParameters(@HeaderParam("enum_header_string_array") @DefaultValue("new ArrayList<String>()") @ApiParam("Header parameter enum test (string array)") List<String> enumHeaderStringArray,@HeaderParam("enum_header_string") @DefaultValue("-efg") @ApiParam("Header parameter enum test (string)") String enumHeaderString,@QueryParam("enum_query_string_array") @DefaultValue("new ArrayList<String>()") @ApiParam("Query parameter enum test (string array)") List<String> enumQueryStringArray,@QueryParam("enum_query_string") @DefaultValue("-efg") @ApiParam("Query parameter enum test (string)") String enumQueryString,@QueryParam("enum_query_integer") @ApiParam("Query parameter enum test (double)") Integer enumQueryInteger,@QueryParam("enum_query_double") @ApiParam("Query parameter enum test (double)") Double enumQueryDouble,@FormParam(value = "enum_form_string_array") List<String> enumFormStringArray,@FormParam(value = "enum_form_string") String enumFormString);
Response testEnumParameters(@HeaderParam("enum_header_string_array") @DefaultValue("new ArrayList<String>()") @ApiParam("Header parameter enum test (string array)") List<String> enumHeaderStringArray,@HeaderParam("enum_header_string") @DefaultValue("-efg") @ApiParam("Header parameter enum test (string)") String enumHeaderString,@QueryParam("enum_query_string_array") @ApiParam("Query parameter enum test (string array)") List<String> enumQueryStringArray,@QueryParam("enum_query_string") @DefaultValue("-efg") @ApiParam("Query parameter enum test (string)") String enumQueryString,@QueryParam("enum_query_integer") @ApiParam("Query parameter enum test (double)") Integer enumQueryInteger,@QueryParam("enum_query_double") @ApiParam("Query parameter enum test (double)") Double enumQueryDouble,@FormParam(value = "enum_form_string_array") List<String> enumFormStringArray,@FormParam(value = "enum_form_string") String enumFormString);

@DELETE
@ApiOperation(value = "Fake endpoint to test group parameters (optional)", notes = "Fake endpoint to test group parameters (optional)", tags={ "fake", })
@ApiResponses(value = {
@ApiResponse(code = 400, message = "Someting wrong", response = Void.class) })
Response testGroupParameters(@QueryParam("required_string_group") @NotNull @ApiParam("Required String in group parameters") Integer requiredStringGroup,@HeaderParam("required_boolean_group") @NotNull @ApiParam("Required Boolean in group parameters") Boolean requiredBooleanGroup,@QueryParam("required_int64_group") @NotNull @ApiParam("Required Integer in group parameters") Long requiredInt64Group,@QueryParam("string_group") @ApiParam("String in group parameters") Integer stringGroup,@HeaderParam("boolean_group") @ApiParam("Boolean in group parameters") Boolean booleanGroup,@QueryParam("int64_group") @ApiParam("Integer in group parameters") Long int64Group);

@POST
@Path("/inline-additionalProperties")
@Consumes({ "application/json" })
@ApiOperation(value = "test inline additionalProperties", notes = "", tags={ "fake", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation", response = Void.class) })
Response testInlineAdditionalProperties(@Valid Map<String, String> requestBody);
Response testInlineAdditionalProperties(@Valid Map<String, String> param);

@GET
@Path("/jsonFormData")
Expand All@@ -116,6 +131,13 @@ public interface FakeApi {
@ApiResponse(code = 200, message = "successful operation", response = Void.class) })
Response testJsonFormData(@FormParam(value = "param") String param,@FormParam(value = "param2") String param2);

@PUT
@Path("/test-query-paramters")
@ApiOperation(value = "", notes = "To test the collection format in query parameters", tags={ "fake", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "Success", response = Void.class) })
Response testQueryParameterCollectionFormat(@QueryParam("pipe") @NotNull List<String> pipe,@QueryParam("ioutil") @NotNull List<String> ioutil,@QueryParam("http") @NotNull List<String> http,@QueryParam("url") @NotNull List<String> url,@QueryParam("context") @NotNull List<String> context);

@POST
@Path("/{petId}/uploadImageWithRequiredFile")
@Consumes({ "multipart/form-data" })
Expand Down
2 changes: 1 addition & 1 deletion ...jaxrs-spec-interface-response/src/gen/java/org/openapitools/api/FakeClassnameTestApi.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,5 +25,5 @@ public interface FakeClassnameTestApi {
}, tags={ "fake_classname_tags 123#$%^" })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation", response = Client.class) })
Response testClassname(@Valid Client client);
Response testClassname(@Valid Client body);
}
13 changes: 8 additions & 5 deletions ...rver/petstore/jaxrs-spec-interface-response/src/gen/java/org/openapitools/api/PetApi.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,8 +28,9 @@ public interface PetApi {
})
}, tags={ "pet", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation", response = Void.class),
@ApiResponse(code = 405, message = "Invalid input", response = Void.class) })
Response addPet(@Valid Pet pet);
Response addPet(@Valid Pet body);

@DELETE
@Path("/{petId}")
Expand All@@ -40,8 +41,9 @@ public interface PetApi {
})
}, tags={ "pet", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation", response = Void.class),
@ApiResponse(code = 400, message = "Invalid pet value", response = Void.class) })
Response deletePet(@PathParam("petId") @ApiParam("Pet id to delete") Long petId,@HeaderParam("api_key") String apiKey);
Response deletePet(@PathParam("petId") @ApiParam("Pet id to delete") Long petId,@HeaderParam("api_key") String apiKey);

@GET
@Path("/findByStatus")
Expand All@@ -55,7 +57,7 @@ public interface PetApi {
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation", response = Pet.class, responseContainer = "List"),
@ApiResponse(code = 400, message = "Invalid status value", response = Void.class, responseContainer = "List") })
Response findPetsByStatus(@QueryParam("status") @NotNull @DefaultValue("new ArrayList<String>()") @ApiParam("Status values that need to be considered for filter") List<String> status);
Response findPetsByStatus(@QueryParam("status") @NotNull @ApiParam("Status values that need to be considered for filter") List<String> status);

@GET
@Path("/findByTags")
Expand All@@ -69,7 +71,7 @@ public interface PetApi {
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation", response = Pet.class, responseContainer = "List"),
@ApiResponse(code = 400, message = "Invalid tag value", response = Void.class, responseContainer = "List") })
Response findPetsByTags(@QueryParam("tags") @NotNull @DefaultValue("new ArrayList<String>()") @ApiParam("Tags to filter by") List<String> tags);
Response findPetsByTags(@QueryParam("tags") @NotNull @ApiParam("Tags to filter by") List<String> tags);

@GET
@Path("/{petId}")
Expand All@@ -92,10 +94,11 @@ public interface PetApi {
})
}, tags={ "pet", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation", response = Void.class),
@ApiResponse(code = 400, message = "Invalid ID supplied", response = Void.class),
@ApiResponse(code = 404, message = "Pet not found", response = Void.class),
@ApiResponse(code = 405, message = "Validation exception", response = Void.class) })
Response updatePet(@Valid Pet pet);
Response updatePet(@Valid Pet body);

@POST
@Path("/{petId}")
Expand Down
2 changes: 1 addition & 1 deletion ...er/petstore/jaxrs-spec-interface-response/src/gen/java/org/openapitools/api/StoreApi.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,5 +53,5 @@ public interface StoreApi {
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation", response = Order.class),
@ApiResponse(code = 400, message = "Invalid Order", response = Void.class) })
Response placeOrder(@Valid Order order);
Response placeOrder(@Valid Order body);
}
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" + '
[jaxrs-spec] Add builders to models by shybovycha · Pull Request #4916 · OpenAPITools/openapi-generator · GitHub
Skip to content
[jaxrs-spec] Add builders to models#4916

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

 Closed

shybovycha
wants to merge
5
commits into

from

 Closed


[jaxrs-spec] Add builders to models
#4916
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
a9add69

Update formatting in jaxrs-spec POJOs


shybovycha Jan 2, 2020
0ee1f21

Add generateBuilders option

Jan 2, 2020
3d620c8

Update formatting in jaxrs-spec POJOs


shybovycha Jan 2, 2020
e41bf0d

Generate samples

Jan 2, 2020
ccb071f

Disable the builders generation by default

Jan 5, 2020

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


11 changes: 10 additions & 1 deletion
...enerator/src/main/java/org/openapitools/codegen/languages/JavaJAXRSSpecServerCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ public class JavaJAXRSSpecServerCodegen extends AbstractJavaJAXRSServerCodegen {
 public static final String USE_SWAGGER_ANNOTATIONS = "useSwaggerAnnotations";
 public static final String JACKSON = "jackson";
 public static final String OPEN_API_SPEC_FILE_LOCATION = "openApiSpecFileLocation";
 public static final String GENERATE_BUILDERS = "generateBuilders";

 public static final String QUARKUS_LIBRARY = "quarkus";
 public static final String THORNTAIL_LIBRARY = "thorntail";
Expand All@@ -51,6 +52,7 @@ public class JavaJAXRSSpecServerCodegen extends AbstractJavaJAXRSServerCodegen {
 private boolean interfaceOnly = false;
 private boolean returnResponse = false;
 private boolean generatePom = true;
 private boolean generateBuilders = false;
 private boolean useSwaggerAnnotations = true;
 private boolean useJackson = false;
 private String openApiSpecFileLocation = "src/main/openapi/openapi.yaml";
Expand DownExpand Up@@ -102,6 +104,7 @@ public JavaJAXRSSpecServerCodegen() {

 cliOptions.add(library);
 cliOptions.add(CliOption.newBoolean(GENERATE_POM, "Whether to generate pom.xml if the file does not already exist.").defaultValue(String.valueOf(generatePom)));
 cliOptions.add(CliOption.newBoolean(GENERATE_BUILDERS, "Whether to generate builders for models.").defaultValue(String.valueOf(generateBuilders)));
 cliOptions.add(CliOption.newBoolean(INTERFACE_ONLY, "Whether to generate only API interface stubs without the server files.").defaultValue(String.valueOf(interfaceOnly)));
 cliOptions.add(CliOption.newBoolean(RETURN_RESPONSE, "Whether generate API interface should return javax.ws.rs.core.Response instead of a deserialized entity. Only useful if interfaceOnly is true.").defaultValue(String.valueOf(returnResponse)));
 cliOptions.add(CliOption.newBoolean(USE_SWAGGER_ANNOTATIONS, "Whether to generate Swagger annotations.", useSwaggerAnnotations));
Expand All@@ -125,14 +128,20 @@ public void processOpts() {
 additionalProperties.remove(RETURN_RESPONSE);
 }
 }
 if(QUARKUS_LIBRARY.equals(library) || THORNTAIL_LIBRARY.equals(library) || HELIDON_LIBRARY.equals(library) || OPEN_LIBERTY_LIBRARY.equals(library)) {
 if(QUARKUS_LIBRARY.equals(library) || THORNTAIL_LIBRARY.equals(library) || HELIDON_LIBRARY.equals(library) || OPEN_LIBERTY_LIBRARY.equals(library)) {
 useSwaggerAnnotations = false;
 } else {
 if (additionalProperties.containsKey(USE_SWAGGER_ANNOTATIONS)) {
 useSwaggerAnnotations = Boolean.valueOf(additionalProperties.get(USE_SWAGGER_ANNOTATIONS).toString());
 }
 }
 writePropertyBack(USE_SWAGGER_ANNOTATIONS, useSwaggerAnnotations);

 if (additionalProperties.containsKey(GENERATE_BUILDERS)) {
 generateBuilders = Boolean.valueOf(additionalProperties.get(GENERATE_BUILDERS).toString());
 }
 additionalProperties.put(GENERATE_BUILDERS, generateBuilders);

 if (additionalProperties.containsKey(OPEN_API_SPEC_FILE_LOCATION)) {
 openApiSpecFileLocation = additionalProperties.get(OPEN_API_SPEC_FILE_LOCATION).toString();
 } else if(QUARKUS_LIBRARY.equals(library) || THORNTAIL_LIBRARY.equals(library) || HELIDON_LIBRARY.equals(library)) {
Expand Down

71 changes: 45 additions & 26 deletions
modules/openapi-generator/src/main/resources/JavaJaxRS/spec/pojo.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,52 +1,38 @@
{{#useSwaggerAnnotations}}
import io.swagger.annotations.*;
{{/useSwaggerAnnotations}}
{{#useSwaggerAnnotations}}import io.swagger.annotations.*;{{/useSwaggerAnnotations}}
Comment thread
shybovycha marked this conversation as resolved.


Outdated

import java.util.Objects;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;

{{#discriminator}}{{>typeInfoAnnotation}}{{/discriminator}}{{#description}}
/**
{{#discriminator}}{{>typeInfoAnnotation}}{{/discriminator}}{{#description}}/**
 * {{description}}
 **/{{/description}}{{#useSwaggerAnnotations}}
{{#description}}{{>additionalModelTypeAnnotations}}@ApiModel(description = "{{{description}}}"){{/description}}{{/useSwaggerAnnotations}}
 **/{{/description}}
{{#useSwaggerAnnotations}}{{#description}}{{>additionalModelTypeAnnotations}}@ApiModel(description = "{{{description}}}"){{/description}}{{/useSwaggerAnnotations}}
public class {{classname}} {{#parent}}extends {{{parent}}}{{/parent}} {{#serializableModel}}implements Serializable{{/serializableModel}} {
 {{#vars}}{{#isEnum}}{{^isContainer}}

{{>enumClass}}{{/isContainer}}{{#isContainer}}{{#mostInnerItems}}

{{>enumClass}}{{/mostInnerItems}}{{/isContainer}}{{/isEnum}}
 private {{#useBeanValidation}}@Valid{{/useBeanValidation}}{{{datatypeWithEnum}}} {{name}}{{#defaultValue}} = {{{.}}}{{/defaultValue}};{{/vars}}
 private {{#useBeanValidation}}@Valid{{/useBeanValidation}}{{{datatypeWithEnum}}} {{name}}{{#defaultValue}} = {{{.}}}{{/defaultValue}};{{/vars}}

 {{#vars}}
 /**
 {{#description}}
 * {{description}}
 {{/description}}
 {{#minimum}}
 * minimum: {{minimum}}
 {{/minimum}}
 {{#maximum}}
 * maximum: {{maximum}}
 {{/maximum}}
 **/
 public {{classname}} {{name}}({{{datatypeWithEnum}}} {{name}}) {
 {{#generateBuilders}}public {{classname}}({{#vars}}{{{datatypeWithEnum}}} {{name}}{{#hasMore}}, {{/hasMore}}{{/vars}}) {
 {{#vars}}
 this.{{name}} = {{name}};
return this;
{{/vars}}
 }
 {{/generateBuilders}}

 {{#vendorExtensions.extraAnnotation}}{{{vendorExtensions.extraAnnotation}}}{{/vendorExtensions.extraAnnotation}}{{#useSwaggerAnnotations}}
 {{#vars}}{{#vendorExtensions.extraAnnotation}}{{{vendorExtensions.extraAnnotation}}}{{/vendorExtensions.extraAnnotation}}{{#useSwaggerAnnotations}}
 @ApiModelProperty({{#example}}example = "{{{example}}}", {{/example}}{{#required}}required = {{required}}, {{/required}}value = "{{{description}}}"){{/useSwaggerAnnotations}}
 @JsonProperty("{{baseName}}")
{{#useBeanValidation}}{{>beanValidation}}{{/useBeanValidation}} public {{{datatypeWithEnum}}} {{getter}}() {
 return {{name}};
 }

 public void {{setter}}({{{datatypeWithEnum}}} {{name}}) {
 this.{{name}} = {{name}};
 }

 {{/vars}}
 }{{/vars}}

 @Override
 public boolean equals(java.lang.Object o) {
Expand DownExpand Up@@ -88,4 +74,37 @@ public class {{classname}} {{#parent}}extends {{{parent}}}{{/parent}} {{#seriali
 }
 return o.toString().replace("\n", "\n ");
 }

 {{#generateBuilders}}
 public static Builder builder() {
 return new Builder();
 }

 public static class Builder {
 {{#vars}}
 private {{{datatypeWithEnum}}} {{name}}{{#defaultValue}} = {{{.}}}{{/defaultValue}};
 {{/vars}}

 {{#vars}}
 /**
 {{#description}}
 * {{description}}
 {{/description}}
 {{#minimum}}
 * minimum: {{minimum}}
 {{/minimum}}
 {{#maximum}}
 * maximum: {{maximum}}
 {{/maximum}}
 **/
 public Builder {{name}}({{{datatypeWithEnum}}} {{name}}) {
 this.{{name}} = {{name}};
 return this;
 }
 {{/vars}}

 public {{classname}} build() {
 return new {{classname}}({{#vars}}{{name}}{{#hasMore}}, {{/hasMore}}{{/vars}});
 }
 }{{/generateBuilders}}
}

2 changes: 1 addition & 1 deletion
samples/server/petstore/jaxrs-spec-interface-response/.openapi-generator/VERSION

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
3.3.0-SNAPSHOT
4.3.0-SNAPSHOT

2 changes: 1 addition & 1 deletion
...store/jaxrs-spec-interface-response/src/gen/java/org/openapitools/api/AnotherFakeApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,5 +24,5 @@ public interface AnotherFakeApi {
 @ApiOperation(value = "To test special tags", notes = "To test special tags and operation ID starting with number", tags={ "$another-fake?" })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Client.class) })
 Response call123testSpecialTags(@Valid Client client);
 Response call123testSpecialTags(@Valid Client body);
}

34 changes: 28 additions & 6 deletions
...ver/petstore/jaxrs-spec-interface-response/src/gen/java/org/openapitools/api/FakeApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@
import org.openapitools.model.ModelApiResponse;
import org.openapitools.model.OuterComposite;
import org.openapitools.model.User;
import org.openapitools.model.XmlItem;

import javax.ws.rs.*;
import javax.ws.rs.core.Response;
Expand All@@ -26,6 +27,14 @@
@Api(description = "the fake API")
public interface FakeApi {

 @POST
 @Path("/create_xml_item")
 @Consumes({ "application/xml", "application/xml; charset=utf-8", "application/xml; charset=utf-16", "text/xml", "text/xml; charset=utf-8", "text/xml; charset=utf-16" })
 @ApiOperation(value = "creates an XmlItem", notes = "this route creates an XmlItem", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Void.class) })
 Response createXmlItem(@Valid XmlItem xmlItem);

 @POST
 @Path("/outer/boolean")
 @Produces({ "*/*" })
Expand All@@ -40,7 +49,7 @@ public interface FakeApi {
 @ApiOperation(value = "", notes = "Test serialization of object with outer number type", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "Output composite", response = OuterComposite.class) })
 Response fakeOuterCompositeSerialize(@Valid OuterComposite outerComposite);
 Response fakeOuterCompositeSerialize(@Valid OuterComposite body);

 @POST
 @Path("/outer/number")
Expand All@@ -64,23 +73,23 @@ public interface FakeApi {
 @ApiOperation(value = "", notes = "For this test, the body for this request much reference a schema named `File`.", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "Success", response = Void.class) })
 Response testBodyWithFileSchema(@Valid FileSchemaTestClass fileSchemaTestClass);
 Response testBodyWithFileSchema(@Valid FileSchemaTestClass body);

 @PUT
 @Path("/body-with-query-params")
 @Consumes({ "application/json" })
 @ApiOperation(value = "", notes = "", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "Success", response = Void.class) })
 Response testBodyWithQueryParams(@QueryParam("query") @NotNull String query,@Valid User user);
 Response testBodyWithQueryParams(@QueryParam("query") @NotNull String query,@Valid User body);
@wing328wing328Jan 3, 2020

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I noticed that the body parameter name changes from user to body. Likely you're not using the latest (or recent) master when creating this PR.
Please merge the latest master of the official repo into your branch and regenerate the sample again.
@shybovychashybovychaJan 3, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have used 4.3.x as the origin of my branch, are you sure I should merge master in?
@wing328wing328Jan 3, 2020

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK. Please put it on hold. I'll take another look over the weekend or next week.

 @PATCH
 @Consumes({ "application/json" })
 @Produces({ "application/json" })
 @ApiOperation(value = "To test \"client\" model", notes = "To test \"client\" model", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Client.class) })
 Response testClientModel(@Valid Client client);
 Response testClientModel(@Valid Client body);

 @POST
 @Consumes({ "application/x-www-form-urlencoded" })
Expand All@@ -98,15 +107,21 @@ public interface FakeApi {
 @ApiResponses(value = { 
 @ApiResponse(code = 400, message = "Invalid request", response = Void.class),
 @ApiResponse(code = 404, message = "Not found", response = Void.class) })
 Response testEnumParameters(@HeaderParam("enum_header_string_array") @DefaultValue("new ArrayList<String>()") @ApiParam("Header parameter enum test (string array)") List<String> enumHeaderStringArray,@HeaderParam("enum_header_string") @DefaultValue("-efg") @ApiParam("Header parameter enum test (string)") String enumHeaderString,@QueryParam("enum_query_string_array") @DefaultValue("new ArrayList<String>()") @ApiParam("Query parameter enum test (string array)") List<String> enumQueryStringArray,@QueryParam("enum_query_string") @DefaultValue("-efg") @ApiParam("Query parameter enum test (string)") String enumQueryString,@QueryParam("enum_query_integer") @ApiParam("Query parameter enum test (double)") Integer enumQueryInteger,@QueryParam("enum_query_double") @ApiParam("Query parameter enum test (double)") Double enumQueryDouble,@FormParam(value = "enum_form_string_array") List<String> enumFormStringArray,@FormParam(value = "enum_form_string") String enumFormString);
 Response testEnumParameters(@HeaderParam("enum_header_string_array") @DefaultValue("new ArrayList<String>()") @ApiParam("Header parameter enum test (string array)") List<String> enumHeaderStringArray,@HeaderParam("enum_header_string") @DefaultValue("-efg") @ApiParam("Header parameter enum test (string)") String enumHeaderString,@QueryParam("enum_query_string_array") @ApiParam("Query parameter enum test (string array)") List<String> enumQueryStringArray,@QueryParam("enum_query_string") @DefaultValue("-efg") @ApiParam("Query parameter enum test (string)") String enumQueryString,@QueryParam("enum_query_integer") @ApiParam("Query parameter enum test (double)") Integer enumQueryInteger,@QueryParam("enum_query_double") @ApiParam("Query parameter enum test (double)") Double enumQueryDouble,@FormParam(value = "enum_form_string_array") List<String> enumFormStringArray,@FormParam(value = "enum_form_string") String enumFormString);

 @DELETE
 @ApiOperation(value = "Fake endpoint to test group parameters (optional)", notes = "Fake endpoint to test group parameters (optional)", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 400, message = "Someting wrong", response = Void.class) })
 Response testGroupParameters(@QueryParam("required_string_group") @NotNull @ApiParam("Required String in group parameters") Integer requiredStringGroup,@HeaderParam("required_boolean_group") @NotNull @ApiParam("Required Boolean in group parameters") Boolean requiredBooleanGroup,@QueryParam("required_int64_group") @NotNull @ApiParam("Required Integer in group parameters") Long requiredInt64Group,@QueryParam("string_group") @ApiParam("String in group parameters") Integer stringGroup,@HeaderParam("boolean_group") @ApiParam("Boolean in group parameters") Boolean booleanGroup,@QueryParam("int64_group") @ApiParam("Integer in group parameters") Long int64Group);

 @POST
 @Path("/inline-additionalProperties")
 @Consumes({ "application/json" })
 @ApiOperation(value = "test inline additionalProperties", notes = "", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Void.class) })
 Response testInlineAdditionalProperties(@Valid Map<String, String> requestBody);
 Response testInlineAdditionalProperties(@Valid Map<String, String> param);

 @GET
 @Path("/jsonFormData")
Expand All@@ -116,6 +131,13 @@ public interface FakeApi {
 @ApiResponse(code = 200, message = "successful operation", response = Void.class) })
 Response testJsonFormData(@FormParam(value = "param") String param,@FormParam(value = "param2") String param2);

 @PUT
 @Path("/test-query-paramters")
 @ApiOperation(value = "", notes = "To test the collection format in query parameters", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "Success", response = Void.class) })
 Response testQueryParameterCollectionFormat(@QueryParam("pipe") @NotNull List<String> pipe,@QueryParam("ioutil") @NotNull List<String> ioutil,@QueryParam("http") @NotNull List<String> http,@QueryParam("url") @NotNull List<String> url,@QueryParam("context") @NotNull List<String> context);

 @POST
 @Path("/{petId}/uploadImageWithRequiredFile")
 @Consumes({ "multipart/form-data" })
Expand Down

2 changes: 1 addition & 1 deletion
...jaxrs-spec-interface-response/src/gen/java/org/openapitools/api/FakeClassnameTestApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,5 +25,5 @@ public interface FakeClassnameTestApi {
 }, tags={ "fake_classname_tags 123#$%^" })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Client.class) })
 Response testClassname(@Valid Client client);
 Response testClassname(@Valid Client body);
}

13 changes: 8 additions & 5 deletions
...rver/petstore/jaxrs-spec-interface-response/src/gen/java/org/openapitools/api/PetApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,8 +28,9 @@ public interface PetApi {
 })
 }, tags={ "pet", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Void.class),
 @ApiResponse(code = 405, message = "Invalid input", response = Void.class) })
 Response addPet(@Valid Pet pet);
 Response addPet(@Valid Pet body);

 @DELETE
 @Path("/{petId}")
Expand All@@ -40,8 +41,9 @@ public interface PetApi {
 })
 }, tags={ "pet", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Void.class),
 @ApiResponse(code = 400, message = "Invalid pet value", response = Void.class) })
 Response deletePet(@PathParam("petId") @ApiParam("Pet id to delete") Long petId,@HeaderParam("api_key") String apiKey);
 Response deletePet(@PathParam("petId") @ApiParam("Pet id to delete") Long petId,@HeaderParam("api_key") String apiKey);

 @GET
 @Path("/findByStatus")
Expand All@@ -55,7 +57,7 @@ public interface PetApi {
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Pet.class, responseContainer = "List"),
 @ApiResponse(code = 400, message = "Invalid status value", response = Void.class, responseContainer = "List") })
 Response findPetsByStatus(@QueryParam("status") @NotNull @DefaultValue("new ArrayList<String>()")  @ApiParam("Status values that need to be considered for filter") List<String> status);
 Response findPetsByStatus(@QueryParam("status") @NotNull @ApiParam("Status values that need to be considered for filter") List<String> status);

 @GET
 @Path("/findByTags")
Expand All@@ -69,7 +71,7 @@ public interface PetApi {
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Pet.class, responseContainer = "List"),
 @ApiResponse(code = 400, message = "Invalid tag value", response = Void.class, responseContainer = "List") })
 Response findPetsByTags(@QueryParam("tags") @NotNull @DefaultValue("new ArrayList<String>()")  @ApiParam("Tags to filter by") List<String> tags);
 Response findPetsByTags(@QueryParam("tags") @NotNull @ApiParam("Tags to filter by") List<String> tags);

 @GET
 @Path("/{petId}")
Expand All@@ -92,10 +94,11 @@ public interface PetApi {
 })
 }, tags={ "pet", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Void.class),
 @ApiResponse(code = 400, message = "Invalid ID supplied", response = Void.class),
 @ApiResponse(code = 404, message = "Pet not found", response = Void.class),
 @ApiResponse(code = 405, message = "Validation exception", response = Void.class) })
 Response updatePet(@Valid Pet pet);
 Response updatePet(@Valid Pet body);

 @POST
 @Path("/{petId}")
Expand Down

2 changes: 1 addition & 1 deletion
...er/petstore/jaxrs-spec-interface-response/src/gen/java/org/openapitools/api/StoreApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,5 +53,5 @@ public interface StoreApi {
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Order.class),
 @ApiResponse(code = 400, message = "Invalid Order", response = Void.class) })
 Response placeOrder(@Valid Order order);
 Response placeOrder(@Valid Order body);
}
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('^' + ".*" + '
[jaxrs-spec] Add builders to models by shybovycha · Pull Request #4916 · OpenAPITools/openapi-generator · GitHub
Skip to content
[jaxrs-spec] Add builders to models#4916

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

 Closed

shybovycha
wants to merge
5
commits into

from

 Closed


[jaxrs-spec] Add builders to models
#4916
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
a9add69

Update formatting in jaxrs-spec POJOs


shybovycha Jan 2, 2020
0ee1f21

Add generateBuilders option

Jan 2, 2020
3d620c8

Update formatting in jaxrs-spec POJOs


shybovycha Jan 2, 2020
e41bf0d

Generate samples

Jan 2, 2020
ccb071f

Disable the builders generation by default

Jan 5, 2020

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


11 changes: 10 additions & 1 deletion
...enerator/src/main/java/org/openapitools/codegen/languages/JavaJAXRSSpecServerCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ public class JavaJAXRSSpecServerCodegen extends AbstractJavaJAXRSServerCodegen {
 public static final String USE_SWAGGER_ANNOTATIONS = "useSwaggerAnnotations";
 public static final String JACKSON = "jackson";
 public static final String OPEN_API_SPEC_FILE_LOCATION = "openApiSpecFileLocation";
 public static final String GENERATE_BUILDERS = "generateBuilders";

 public static final String QUARKUS_LIBRARY = "quarkus";
 public static final String THORNTAIL_LIBRARY = "thorntail";
Expand All@@ -51,6 +52,7 @@ public class JavaJAXRSSpecServerCodegen extends AbstractJavaJAXRSServerCodegen {
 private boolean interfaceOnly = false;
 private boolean returnResponse = false;
 private boolean generatePom = true;
 private boolean generateBuilders = false;
 private boolean useSwaggerAnnotations = true;
 private boolean useJackson = false;
 private String openApiSpecFileLocation = "src/main/openapi/openapi.yaml";
Expand DownExpand Up@@ -102,6 +104,7 @@ public JavaJAXRSSpecServerCodegen() {

 cliOptions.add(library);
 cliOptions.add(CliOption.newBoolean(GENERATE_POM, "Whether to generate pom.xml if the file does not already exist.").defaultValue(String.valueOf(generatePom)));
 cliOptions.add(CliOption.newBoolean(GENERATE_BUILDERS, "Whether to generate builders for models.").defaultValue(String.valueOf(generateBuilders)));
 cliOptions.add(CliOption.newBoolean(INTERFACE_ONLY, "Whether to generate only API interface stubs without the server files.").defaultValue(String.valueOf(interfaceOnly)));
 cliOptions.add(CliOption.newBoolean(RETURN_RESPONSE, "Whether generate API interface should return javax.ws.rs.core.Response instead of a deserialized entity. Only useful if interfaceOnly is true.").defaultValue(String.valueOf(returnResponse)));
 cliOptions.add(CliOption.newBoolean(USE_SWAGGER_ANNOTATIONS, "Whether to generate Swagger annotations.", useSwaggerAnnotations));
Expand All@@ -125,14 +128,20 @@ public void processOpts() {
 additionalProperties.remove(RETURN_RESPONSE);
 }
 }
 if(QUARKUS_LIBRARY.equals(library) || THORNTAIL_LIBRARY.equals(library) || HELIDON_LIBRARY.equals(library) || OPEN_LIBERTY_LIBRARY.equals(library)) {
 if(QUARKUS_LIBRARY.equals(library) || THORNTAIL_LIBRARY.equals(library) || HELIDON_LIBRARY.equals(library) || OPEN_LIBERTY_LIBRARY.equals(library)) {
 useSwaggerAnnotations = false;
 } else {
 if (additionalProperties.containsKey(USE_SWAGGER_ANNOTATIONS)) {
 useSwaggerAnnotations = Boolean.valueOf(additionalProperties.get(USE_SWAGGER_ANNOTATIONS).toString());
 }
 }
 writePropertyBack(USE_SWAGGER_ANNOTATIONS, useSwaggerAnnotations);

 if (additionalProperties.containsKey(GENERATE_BUILDERS)) {
 generateBuilders = Boolean.valueOf(additionalProperties.get(GENERATE_BUILDERS).toString());
 }
 additionalProperties.put(GENERATE_BUILDERS, generateBuilders);

 if (additionalProperties.containsKey(OPEN_API_SPEC_FILE_LOCATION)) {
 openApiSpecFileLocation = additionalProperties.get(OPEN_API_SPEC_FILE_LOCATION).toString();
 } else if(QUARKUS_LIBRARY.equals(library) || THORNTAIL_LIBRARY.equals(library) || HELIDON_LIBRARY.equals(library)) {
Expand Down

71 changes: 45 additions & 26 deletions
modules/openapi-generator/src/main/resources/JavaJaxRS/spec/pojo.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,52 +1,38 @@
{{#useSwaggerAnnotations}}
import io.swagger.annotations.*;
{{/useSwaggerAnnotations}}
{{#useSwaggerAnnotations}}import io.swagger.annotations.*;{{/useSwaggerAnnotations}}
Comment thread
shybovycha marked this conversation as resolved.


Outdated

import java.util.Objects;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;

{{#discriminator}}{{>typeInfoAnnotation}}{{/discriminator}}{{#description}}
/**
{{#discriminator}}{{>typeInfoAnnotation}}{{/discriminator}}{{#description}}/**
 * {{description}}
 **/{{/description}}{{#useSwaggerAnnotations}}
{{#description}}{{>additionalModelTypeAnnotations}}@ApiModel(description = "{{{description}}}"){{/description}}{{/useSwaggerAnnotations}}
 **/{{/description}}
{{#useSwaggerAnnotations}}{{#description}}{{>additionalModelTypeAnnotations}}@ApiModel(description = "{{{description}}}"){{/description}}{{/useSwaggerAnnotations}}
public class {{classname}} {{#parent}}extends {{{parent}}}{{/parent}} {{#serializableModel}}implements Serializable{{/serializableModel}} {
 {{#vars}}{{#isEnum}}{{^isContainer}}

{{>enumClass}}{{/isContainer}}{{#isContainer}}{{#mostInnerItems}}

{{>enumClass}}{{/mostInnerItems}}{{/isContainer}}{{/isEnum}}
 private {{#useBeanValidation}}@Valid{{/useBeanValidation}}{{{datatypeWithEnum}}} {{name}}{{#defaultValue}} = {{{.}}}{{/defaultValue}};{{/vars}}
 private {{#useBeanValidation}}@Valid{{/useBeanValidation}}{{{datatypeWithEnum}}} {{name}}{{#defaultValue}} = {{{.}}}{{/defaultValue}};{{/vars}}

 {{#vars}}
 /**
 {{#description}}
 * {{description}}
 {{/description}}
 {{#minimum}}
 * minimum: {{minimum}}
 {{/minimum}}
 {{#maximum}}
 * maximum: {{maximum}}
 {{/maximum}}
 **/
 public {{classname}} {{name}}({{{datatypeWithEnum}}} {{name}}) {
 {{#generateBuilders}}public {{classname}}({{#vars}}{{{datatypeWithEnum}}} {{name}}{{#hasMore}}, {{/hasMore}}{{/vars}}) {
 {{#vars}}
 this.{{name}} = {{name}};
return this;
{{/vars}}
 }
 {{/generateBuilders}}

 {{#vendorExtensions.extraAnnotation}}{{{vendorExtensions.extraAnnotation}}}{{/vendorExtensions.extraAnnotation}}{{#useSwaggerAnnotations}}
 {{#vars}}{{#vendorExtensions.extraAnnotation}}{{{vendorExtensions.extraAnnotation}}}{{/vendorExtensions.extraAnnotation}}{{#useSwaggerAnnotations}}
 @ApiModelProperty({{#example}}example = "{{{example}}}", {{/example}}{{#required}}required = {{required}}, {{/required}}value = "{{{description}}}"){{/useSwaggerAnnotations}}
 @JsonProperty("{{baseName}}")
{{#useBeanValidation}}{{>beanValidation}}{{/useBeanValidation}} public {{{datatypeWithEnum}}} {{getter}}() {
 return {{name}};
 }

 public void {{setter}}({{{datatypeWithEnum}}} {{name}}) {
 this.{{name}} = {{name}};
 }

 {{/vars}}
 }{{/vars}}

 @Override
 public boolean equals(java.lang.Object o) {
Expand DownExpand Up@@ -88,4 +74,37 @@ public class {{classname}} {{#parent}}extends {{{parent}}}{{/parent}} {{#seriali
 }
 return o.toString().replace("\n", "\n ");
 }

 {{#generateBuilders}}
 public static Builder builder() {
 return new Builder();
 }

 public static class Builder {
 {{#vars}}
 private {{{datatypeWithEnum}}} {{name}}{{#defaultValue}} = {{{.}}}{{/defaultValue}};
 {{/vars}}

 {{#vars}}
 /**
 {{#description}}
 * {{description}}
 {{/description}}
 {{#minimum}}
 * minimum: {{minimum}}
 {{/minimum}}
 {{#maximum}}
 * maximum: {{maximum}}
 {{/maximum}}
 **/
 public Builder {{name}}({{{datatypeWithEnum}}} {{name}}) {
 this.{{name}} = {{name}};
 return this;
 }
 {{/vars}}

 public {{classname}} build() {
 return new {{classname}}({{#vars}}{{name}}{{#hasMore}}, {{/hasMore}}{{/vars}});
 }
 }{{/generateBuilders}}
}

2 changes: 1 addition & 1 deletion
samples/server/petstore/jaxrs-spec-interface-response/.openapi-generator/VERSION

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
3.3.0-SNAPSHOT
4.3.0-SNAPSHOT

2 changes: 1 addition & 1 deletion
...store/jaxrs-spec-interface-response/src/gen/java/org/openapitools/api/AnotherFakeApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,5 +24,5 @@ public interface AnotherFakeApi {
 @ApiOperation(value = "To test special tags", notes = "To test special tags and operation ID starting with number", tags={ "$another-fake?" })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Client.class) })
 Response call123testSpecialTags(@Valid Client client);
 Response call123testSpecialTags(@Valid Client body);
}

34 changes: 28 additions & 6 deletions
...ver/petstore/jaxrs-spec-interface-response/src/gen/java/org/openapitools/api/FakeApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@
import org.openapitools.model.ModelApiResponse;
import org.openapitools.model.OuterComposite;
import org.openapitools.model.User;
import org.openapitools.model.XmlItem;

import javax.ws.rs.*;
import javax.ws.rs.core.Response;
Expand All@@ -26,6 +27,14 @@
@Api(description = "the fake API")
public interface FakeApi {

 @POST
 @Path("/create_xml_item")
 @Consumes({ "application/xml", "application/xml; charset=utf-8", "application/xml; charset=utf-16", "text/xml", "text/xml; charset=utf-8", "text/xml; charset=utf-16" })
 @ApiOperation(value = "creates an XmlItem", notes = "this route creates an XmlItem", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Void.class) })
 Response createXmlItem(@Valid XmlItem xmlItem);

 @POST
 @Path("/outer/boolean")
 @Produces({ "*/*" })
Expand All@@ -40,7 +49,7 @@ public interface FakeApi {
 @ApiOperation(value = "", notes = "Test serialization of object with outer number type", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "Output composite", response = OuterComposite.class) })
 Response fakeOuterCompositeSerialize(@Valid OuterComposite outerComposite);
 Response fakeOuterCompositeSerialize(@Valid OuterComposite body);

 @POST
 @Path("/outer/number")
Expand All@@ -64,23 +73,23 @@ public interface FakeApi {
 @ApiOperation(value = "", notes = "For this test, the body for this request much reference a schema named `File`.", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "Success", response = Void.class) })
 Response testBodyWithFileSchema(@Valid FileSchemaTestClass fileSchemaTestClass);
 Response testBodyWithFileSchema(@Valid FileSchemaTestClass body);

 @PUT
 @Path("/body-with-query-params")
 @Consumes({ "application/json" })
 @ApiOperation(value = "", notes = "", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "Success", response = Void.class) })
 Response testBodyWithQueryParams(@QueryParam("query") @NotNull String query,@Valid User user);
 Response testBodyWithQueryParams(@QueryParam("query") @NotNull String query,@Valid User body);
@wing328wing328Jan 3, 2020

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I noticed that the body parameter name changes from user to body. Likely you're not using the latest (or recent) master when creating this PR.
Please merge the latest master of the official repo into your branch and regenerate the sample again.
@shybovychashybovychaJan 3, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have used 4.3.x as the origin of my branch, are you sure I should merge master in?
@wing328wing328Jan 3, 2020

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK. Please put it on hold. I'll take another look over the weekend or next week.

 @PATCH
 @Consumes({ "application/json" })
 @Produces({ "application/json" })
 @ApiOperation(value = "To test \"client\" model", notes = "To test \"client\" model", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Client.class) })
 Response testClientModel(@Valid Client client);
 Response testClientModel(@Valid Client body);

 @POST
 @Consumes({ "application/x-www-form-urlencoded" })
Expand All@@ -98,15 +107,21 @@ public interface FakeApi {
 @ApiResponses(value = { 
 @ApiResponse(code = 400, message = "Invalid request", response = Void.class),
 @ApiResponse(code = 404, message = "Not found", response = Void.class) })
 Response testEnumParameters(@HeaderParam("enum_header_string_array") @DefaultValue("new ArrayList<String>()") @ApiParam("Header parameter enum test (string array)") List<String> enumHeaderStringArray,@HeaderParam("enum_header_string") @DefaultValue("-efg") @ApiParam("Header parameter enum test (string)") String enumHeaderString,@QueryParam("enum_query_string_array") @DefaultValue("new ArrayList<String>()") @ApiParam("Query parameter enum test (string array)") List<String> enumQueryStringArray,@QueryParam("enum_query_string") @DefaultValue("-efg") @ApiParam("Query parameter enum test (string)") String enumQueryString,@QueryParam("enum_query_integer") @ApiParam("Query parameter enum test (double)") Integer enumQueryInteger,@QueryParam("enum_query_double") @ApiParam("Query parameter enum test (double)") Double enumQueryDouble,@FormParam(value = "enum_form_string_array") List<String> enumFormStringArray,@FormParam(value = "enum_form_string") String enumFormString);
 Response testEnumParameters(@HeaderParam("enum_header_string_array") @DefaultValue("new ArrayList<String>()") @ApiParam("Header parameter enum test (string array)") List<String> enumHeaderStringArray,@HeaderParam("enum_header_string") @DefaultValue("-efg") @ApiParam("Header parameter enum test (string)") String enumHeaderString,@QueryParam("enum_query_string_array") @ApiParam("Query parameter enum test (string array)") List<String> enumQueryStringArray,@QueryParam("enum_query_string") @DefaultValue("-efg") @ApiParam("Query parameter enum test (string)") String enumQueryString,@QueryParam("enum_query_integer") @ApiParam("Query parameter enum test (double)") Integer enumQueryInteger,@QueryParam("enum_query_double") @ApiParam("Query parameter enum test (double)") Double enumQueryDouble,@FormParam(value = "enum_form_string_array") List<String> enumFormStringArray,@FormParam(value = "enum_form_string") String enumFormString);

 @DELETE
 @ApiOperation(value = "Fake endpoint to test group parameters (optional)", notes = "Fake endpoint to test group parameters (optional)", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 400, message = "Someting wrong", response = Void.class) })
 Response testGroupParameters(@QueryParam("required_string_group") @NotNull @ApiParam("Required String in group parameters") Integer requiredStringGroup,@HeaderParam("required_boolean_group") @NotNull @ApiParam("Required Boolean in group parameters") Boolean requiredBooleanGroup,@QueryParam("required_int64_group") @NotNull @ApiParam("Required Integer in group parameters") Long requiredInt64Group,@QueryParam("string_group") @ApiParam("String in group parameters") Integer stringGroup,@HeaderParam("boolean_group") @ApiParam("Boolean in group parameters") Boolean booleanGroup,@QueryParam("int64_group") @ApiParam("Integer in group parameters") Long int64Group);

 @POST
 @Path("/inline-additionalProperties")
 @Consumes({ "application/json" })
 @ApiOperation(value = "test inline additionalProperties", notes = "", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Void.class) })
 Response testInlineAdditionalProperties(@Valid Map<String, String> requestBody);
 Response testInlineAdditionalProperties(@Valid Map<String, String> param);

 @GET
 @Path("/jsonFormData")
Expand All@@ -116,6 +131,13 @@ public interface FakeApi {
 @ApiResponse(code = 200, message = "successful operation", response = Void.class) })
 Response testJsonFormData(@FormParam(value = "param") String param,@FormParam(value = "param2") String param2);

 @PUT
 @Path("/test-query-paramters")
 @ApiOperation(value = "", notes = "To test the collection format in query parameters", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "Success", response = Void.class) })
 Response testQueryParameterCollectionFormat(@QueryParam("pipe") @NotNull List<String> pipe,@QueryParam("ioutil") @NotNull List<String> ioutil,@QueryParam("http") @NotNull List<String> http,@QueryParam("url") @NotNull List<String> url,@QueryParam("context") @NotNull List<String> context);

 @POST
 @Path("/{petId}/uploadImageWithRequiredFile")
 @Consumes({ "multipart/form-data" })
Expand Down

2 changes: 1 addition & 1 deletion
...jaxrs-spec-interface-response/src/gen/java/org/openapitools/api/FakeClassnameTestApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,5 +25,5 @@ public interface FakeClassnameTestApi {
 }, tags={ "fake_classname_tags 123#$%^" })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Client.class) })
 Response testClassname(@Valid Client client);
 Response testClassname(@Valid Client body);
}

13 changes: 8 additions & 5 deletions
...rver/petstore/jaxrs-spec-interface-response/src/gen/java/org/openapitools/api/PetApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,8 +28,9 @@ public interface PetApi {
 })
 }, tags={ "pet", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Void.class),
 @ApiResponse(code = 405, message = "Invalid input", response = Void.class) })
 Response addPet(@Valid Pet pet);
 Response addPet(@Valid Pet body);

 @DELETE
 @Path("/{petId}")
Expand All@@ -40,8 +41,9 @@ public interface PetApi {
 })
 }, tags={ "pet", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Void.class),
 @ApiResponse(code = 400, message = "Invalid pet value", response = Void.class) })
 Response deletePet(@PathParam("petId") @ApiParam("Pet id to delete") Long petId,@HeaderParam("api_key") String apiKey);
 Response deletePet(@PathParam("petId") @ApiParam("Pet id to delete") Long petId,@HeaderParam("api_key") String apiKey);

 @GET
 @Path("/findByStatus")
Expand All@@ -55,7 +57,7 @@ public interface PetApi {
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Pet.class, responseContainer = "List"),
 @ApiResponse(code = 400, message = "Invalid status value", response = Void.class, responseContainer = "List") })
 Response findPetsByStatus(@QueryParam("status") @NotNull @DefaultValue("new ArrayList<String>()")  @ApiParam("Status values that need to be considered for filter") List<String> status);
 Response findPetsByStatus(@QueryParam("status") @NotNull @ApiParam("Status values that need to be considered for filter") List<String> status);

 @GET
 @Path("/findByTags")
Expand All@@ -69,7 +71,7 @@ public interface PetApi {
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Pet.class, responseContainer = "List"),
 @ApiResponse(code = 400, message = "Invalid tag value", response = Void.class, responseContainer = "List") })
 Response findPetsByTags(@QueryParam("tags") @NotNull @DefaultValue("new ArrayList<String>()")  @ApiParam("Tags to filter by") List<String> tags);
 Response findPetsByTags(@QueryParam("tags") @NotNull @ApiParam("Tags to filter by") List<String> tags);

 @GET
 @Path("/{petId}")
Expand All@@ -92,10 +94,11 @@ public interface PetApi {
 })
 }, tags={ "pet", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Void.class),
 @ApiResponse(code = 400, message = "Invalid ID supplied", response = Void.class),
 @ApiResponse(code = 404, message = "Pet not found", response = Void.class),
 @ApiResponse(code = 405, message = "Validation exception", response = Void.class) })
 Response updatePet(@Valid Pet pet);
 Response updatePet(@Valid Pet body);

 @POST
 @Path("/{petId}")
Expand Down

2 changes: 1 addition & 1 deletion
...er/petstore/jaxrs-spec-interface-response/src/gen/java/org/openapitools/api/StoreApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,5 +53,5 @@ public interface StoreApi {
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Order.class),
 @ApiResponse(code = 400, message = "Invalid Order", response = Void.class) })
 Response placeOrder(@Valid Order order);
 Response placeOrder(@Valid Order body);
}
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('^' + ".*" + '
[jaxrs-spec] Add builders to models by shybovycha · Pull Request #4916 · OpenAPITools/openapi-generator · GitHub
Skip to content
[jaxrs-spec] Add builders to models#4916

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

 Closed

shybovycha
wants to merge
5
commits into

from

 Closed


[jaxrs-spec] Add builders to models
#4916
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
a9add69

Update formatting in jaxrs-spec POJOs


shybovycha Jan 2, 2020
0ee1f21

Add generateBuilders option

Jan 2, 2020
3d620c8

Update formatting in jaxrs-spec POJOs


shybovycha Jan 2, 2020
e41bf0d

Generate samples

Jan 2, 2020
ccb071f

Disable the builders generation by default

Jan 5, 2020

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


11 changes: 10 additions & 1 deletion
...enerator/src/main/java/org/openapitools/codegen/languages/JavaJAXRSSpecServerCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ public class JavaJAXRSSpecServerCodegen extends AbstractJavaJAXRSServerCodegen {
 public static final String USE_SWAGGER_ANNOTATIONS = "useSwaggerAnnotations";
 public static final String JACKSON = "jackson";
 public static final String OPEN_API_SPEC_FILE_LOCATION = "openApiSpecFileLocation";
 public static final String GENERATE_BUILDERS = "generateBuilders";

 public static final String QUARKUS_LIBRARY = "quarkus";
 public static final String THORNTAIL_LIBRARY = "thorntail";
Expand All@@ -51,6 +52,7 @@ public class JavaJAXRSSpecServerCodegen extends AbstractJavaJAXRSServerCodegen {
 private boolean interfaceOnly = false;
 private boolean returnResponse = false;
 private boolean generatePom = true;
 private boolean generateBuilders = false;
 private boolean useSwaggerAnnotations = true;
 private boolean useJackson = false;
 private String openApiSpecFileLocation = "src/main/openapi/openapi.yaml";
Expand DownExpand Up@@ -102,6 +104,7 @@ public JavaJAXRSSpecServerCodegen() {

 cliOptions.add(library);
 cliOptions.add(CliOption.newBoolean(GENERATE_POM, "Whether to generate pom.xml if the file does not already exist.").defaultValue(String.valueOf(generatePom)));
 cliOptions.add(CliOption.newBoolean(GENERATE_BUILDERS, "Whether to generate builders for models.").defaultValue(String.valueOf(generateBuilders)));
 cliOptions.add(CliOption.newBoolean(INTERFACE_ONLY, "Whether to generate only API interface stubs without the server files.").defaultValue(String.valueOf(interfaceOnly)));
 cliOptions.add(CliOption.newBoolean(RETURN_RESPONSE, "Whether generate API interface should return javax.ws.rs.core.Response instead of a deserialized entity. Only useful if interfaceOnly is true.").defaultValue(String.valueOf(returnResponse)));
 cliOptions.add(CliOption.newBoolean(USE_SWAGGER_ANNOTATIONS, "Whether to generate Swagger annotations.", useSwaggerAnnotations));
Expand All@@ -125,14 +128,20 @@ public void processOpts() {
 additionalProperties.remove(RETURN_RESPONSE);
 }
 }
 if(QUARKUS_LIBRARY.equals(library) || THORNTAIL_LIBRARY.equals(library) || HELIDON_LIBRARY.equals(library) || OPEN_LIBERTY_LIBRARY.equals(library)) {
 if(QUARKUS_LIBRARY.equals(library) || THORNTAIL_LIBRARY.equals(library) || HELIDON_LIBRARY.equals(library) || OPEN_LIBERTY_LIBRARY.equals(library)) {
 useSwaggerAnnotations = false;
 } else {
 if (additionalProperties.containsKey(USE_SWAGGER_ANNOTATIONS)) {
 useSwaggerAnnotations = Boolean.valueOf(additionalProperties.get(USE_SWAGGER_ANNOTATIONS).toString());
 }
 }
 writePropertyBack(USE_SWAGGER_ANNOTATIONS, useSwaggerAnnotations);

 if (additionalProperties.containsKey(GENERATE_BUILDERS)) {
 generateBuilders = Boolean.valueOf(additionalProperties.get(GENERATE_BUILDERS).toString());
 }
 additionalProperties.put(GENERATE_BUILDERS, generateBuilders);

 if (additionalProperties.containsKey(OPEN_API_SPEC_FILE_LOCATION)) {
 openApiSpecFileLocation = additionalProperties.get(OPEN_API_SPEC_FILE_LOCATION).toString();
 } else if(QUARKUS_LIBRARY.equals(library) || THORNTAIL_LIBRARY.equals(library) || HELIDON_LIBRARY.equals(library)) {
Expand Down

71 changes: 45 additions & 26 deletions
modules/openapi-generator/src/main/resources/JavaJaxRS/spec/pojo.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,52 +1,38 @@
{{#useSwaggerAnnotations}}
import io.swagger.annotations.*;
{{/useSwaggerAnnotations}}
{{#useSwaggerAnnotations}}import io.swagger.annotations.*;{{/useSwaggerAnnotations}}
Comment thread
shybovycha marked this conversation as resolved.


Outdated

import java.util.Objects;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;

{{#discriminator}}{{>typeInfoAnnotation}}{{/discriminator}}{{#description}}
/**
{{#discriminator}}{{>typeInfoAnnotation}}{{/discriminator}}{{#description}}/**
 * {{description}}
 **/{{/description}}{{#useSwaggerAnnotations}}
{{#description}}{{>additionalModelTypeAnnotations}}@ApiModel(description = "{{{description}}}"){{/description}}{{/useSwaggerAnnotations}}
 **/{{/description}}
{{#useSwaggerAnnotations}}{{#description}}{{>additionalModelTypeAnnotations}}@ApiModel(description = "{{{description}}}"){{/description}}{{/useSwaggerAnnotations}}
public class {{classname}} {{#parent}}extends {{{parent}}}{{/parent}} {{#serializableModel}}implements Serializable{{/serializableModel}} {
 {{#vars}}{{#isEnum}}{{^isContainer}}

{{>enumClass}}{{/isContainer}}{{#isContainer}}{{#mostInnerItems}}

{{>enumClass}}{{/mostInnerItems}}{{/isContainer}}{{/isEnum}}
 private {{#useBeanValidation}}@Valid{{/useBeanValidation}}{{{datatypeWithEnum}}} {{name}}{{#defaultValue}} = {{{.}}}{{/defaultValue}};{{/vars}}
 private {{#useBeanValidation}}@Valid{{/useBeanValidation}}{{{datatypeWithEnum}}} {{name}}{{#defaultValue}} = {{{.}}}{{/defaultValue}};{{/vars}}

 {{#vars}}
 /**
 {{#description}}
 * {{description}}
 {{/description}}
 {{#minimum}}
 * minimum: {{minimum}}
 {{/minimum}}
 {{#maximum}}
 * maximum: {{maximum}}
 {{/maximum}}
 **/
 public {{classname}} {{name}}({{{datatypeWithEnum}}} {{name}}) {
 {{#generateBuilders}}public {{classname}}({{#vars}}{{{datatypeWithEnum}}} {{name}}{{#hasMore}}, {{/hasMore}}{{/vars}}) {
 {{#vars}}
 this.{{name}} = {{name}};
return this;
{{/vars}}
 }
 {{/generateBuilders}}

 {{#vendorExtensions.extraAnnotation}}{{{vendorExtensions.extraAnnotation}}}{{/vendorExtensions.extraAnnotation}}{{#useSwaggerAnnotations}}
 {{#vars}}{{#vendorExtensions.extraAnnotation}}{{{vendorExtensions.extraAnnotation}}}{{/vendorExtensions.extraAnnotation}}{{#useSwaggerAnnotations}}
 @ApiModelProperty({{#example}}example = "{{{example}}}", {{/example}}{{#required}}required = {{required}}, {{/required}}value = "{{{description}}}"){{/useSwaggerAnnotations}}
 @JsonProperty("{{baseName}}")
{{#useBeanValidation}}{{>beanValidation}}{{/useBeanValidation}} public {{{datatypeWithEnum}}} {{getter}}() {
 return {{name}};
 }

 public void {{setter}}({{{datatypeWithEnum}}} {{name}}) {
 this.{{name}} = {{name}};
 }

 {{/vars}}
 }{{/vars}}

 @Override
 public boolean equals(java.lang.Object o) {
Expand DownExpand Up@@ -88,4 +74,37 @@ public class {{classname}} {{#parent}}extends {{{parent}}}{{/parent}} {{#seriali
 }
 return o.toString().replace("\n", "\n ");
 }

 {{#generateBuilders}}
 public static Builder builder() {
 return new Builder();
 }

 public static class Builder {
 {{#vars}}
 private {{{datatypeWithEnum}}} {{name}}{{#defaultValue}} = {{{.}}}{{/defaultValue}};
 {{/vars}}

 {{#vars}}
 /**
 {{#description}}
 * {{description}}
 {{/description}}
 {{#minimum}}
 * minimum: {{minimum}}
 {{/minimum}}
 {{#maximum}}
 * maximum: {{maximum}}
 {{/maximum}}
 **/
 public Builder {{name}}({{{datatypeWithEnum}}} {{name}}) {
 this.{{name}} = {{name}};
 return this;
 }
 {{/vars}}

 public {{classname}} build() {
 return new {{classname}}({{#vars}}{{name}}{{#hasMore}}, {{/hasMore}}{{/vars}});
 }
 }{{/generateBuilders}}
}

2 changes: 1 addition & 1 deletion
samples/server/petstore/jaxrs-spec-interface-response/.openapi-generator/VERSION

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
3.3.0-SNAPSHOT
4.3.0-SNAPSHOT

2 changes: 1 addition & 1 deletion
...store/jaxrs-spec-interface-response/src/gen/java/org/openapitools/api/AnotherFakeApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,5 +24,5 @@ public interface AnotherFakeApi {
 @ApiOperation(value = "To test special tags", notes = "To test special tags and operation ID starting with number", tags={ "$another-fake?" })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Client.class) })
 Response call123testSpecialTags(@Valid Client client);
 Response call123testSpecialTags(@Valid Client body);
}

34 changes: 28 additions & 6 deletions
...ver/petstore/jaxrs-spec-interface-response/src/gen/java/org/openapitools/api/FakeApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@
import org.openapitools.model.ModelApiResponse;
import org.openapitools.model.OuterComposite;
import org.openapitools.model.User;
import org.openapitools.model.XmlItem;

import javax.ws.rs.*;
import javax.ws.rs.core.Response;
Expand All@@ -26,6 +27,14 @@
@Api(description = "the fake API")
public interface FakeApi {

 @POST
 @Path("/create_xml_item")
 @Consumes({ "application/xml", "application/xml; charset=utf-8", "application/xml; charset=utf-16", "text/xml", "text/xml; charset=utf-8", "text/xml; charset=utf-16" })
 @ApiOperation(value = "creates an XmlItem", notes = "this route creates an XmlItem", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Void.class) })
 Response createXmlItem(@Valid XmlItem xmlItem);

 @POST
 @Path("/outer/boolean")
 @Produces({ "*/*" })
Expand All@@ -40,7 +49,7 @@ public interface FakeApi {
 @ApiOperation(value = "", notes = "Test serialization of object with outer number type", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "Output composite", response = OuterComposite.class) })
 Response fakeOuterCompositeSerialize(@Valid OuterComposite outerComposite);
 Response fakeOuterCompositeSerialize(@Valid OuterComposite body);

 @POST
 @Path("/outer/number")
Expand All@@ -64,23 +73,23 @@ public interface FakeApi {
 @ApiOperation(value = "", notes = "For this test, the body for this request much reference a schema named `File`.", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "Success", response = Void.class) })
 Response testBodyWithFileSchema(@Valid FileSchemaTestClass fileSchemaTestClass);
 Response testBodyWithFileSchema(@Valid FileSchemaTestClass body);

 @PUT
 @Path("/body-with-query-params")
 @Consumes({ "application/json" })
 @ApiOperation(value = "", notes = "", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "Success", response = Void.class) })
 Response testBodyWithQueryParams(@QueryParam("query") @NotNull String query,@Valid User user);
 Response testBodyWithQueryParams(@QueryParam("query") @NotNull String query,@Valid User body);
@wing328wing328Jan 3, 2020

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I noticed that the body parameter name changes from user to body. Likely you're not using the latest (or recent) master when creating this PR.
Please merge the latest master of the official repo into your branch and regenerate the sample again.
@shybovychashybovychaJan 3, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have used 4.3.x as the origin of my branch, are you sure I should merge master in?
@wing328wing328Jan 3, 2020

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK. Please put it on hold. I'll take another look over the weekend or next week.

 @PATCH
 @Consumes({ "application/json" })
 @Produces({ "application/json" })
 @ApiOperation(value = "To test \"client\" model", notes = "To test \"client\" model", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Client.class) })
 Response testClientModel(@Valid Client client);
 Response testClientModel(@Valid Client body);

 @POST
 @Consumes({ "application/x-www-form-urlencoded" })
Expand All@@ -98,15 +107,21 @@ public interface FakeApi {
 @ApiResponses(value = { 
 @ApiResponse(code = 400, message = "Invalid request", response = Void.class),
 @ApiResponse(code = 404, message = "Not found", response = Void.class) })
 Response testEnumParameters(@HeaderParam("enum_header_string_array") @DefaultValue("new ArrayList<String>()") @ApiParam("Header parameter enum test (string array)") List<String> enumHeaderStringArray,@HeaderParam("enum_header_string") @DefaultValue("-efg") @ApiParam("Header parameter enum test (string)") String enumHeaderString,@QueryParam("enum_query_string_array") @DefaultValue("new ArrayList<String>()") @ApiParam("Query parameter enum test (string array)") List<String> enumQueryStringArray,@QueryParam("enum_query_string") @DefaultValue("-efg") @ApiParam("Query parameter enum test (string)") String enumQueryString,@QueryParam("enum_query_integer") @ApiParam("Query parameter enum test (double)") Integer enumQueryInteger,@QueryParam("enum_query_double") @ApiParam("Query parameter enum test (double)") Double enumQueryDouble,@FormParam(value = "enum_form_string_array") List<String> enumFormStringArray,@FormParam(value = "enum_form_string") String enumFormString);
 Response testEnumParameters(@HeaderParam("enum_header_string_array") @DefaultValue("new ArrayList<String>()") @ApiParam("Header parameter enum test (string array)") List<String> enumHeaderStringArray,@HeaderParam("enum_header_string") @DefaultValue("-efg") @ApiParam("Header parameter enum test (string)") String enumHeaderString,@QueryParam("enum_query_string_array") @ApiParam("Query parameter enum test (string array)") List<String> enumQueryStringArray,@QueryParam("enum_query_string") @DefaultValue("-efg") @ApiParam("Query parameter enum test (string)") String enumQueryString,@QueryParam("enum_query_integer") @ApiParam("Query parameter enum test (double)") Integer enumQueryInteger,@QueryParam("enum_query_double") @ApiParam("Query parameter enum test (double)") Double enumQueryDouble,@FormParam(value = "enum_form_string_array") List<String> enumFormStringArray,@FormParam(value = "enum_form_string") String enumFormString);

 @DELETE
 @ApiOperation(value = "Fake endpoint to test group parameters (optional)", notes = "Fake endpoint to test group parameters (optional)", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 400, message = "Someting wrong", response = Void.class) })
 Response testGroupParameters(@QueryParam("required_string_group") @NotNull @ApiParam("Required String in group parameters") Integer requiredStringGroup,@HeaderParam("required_boolean_group") @NotNull @ApiParam("Required Boolean in group parameters") Boolean requiredBooleanGroup,@QueryParam("required_int64_group") @NotNull @ApiParam("Required Integer in group parameters") Long requiredInt64Group,@QueryParam("string_group") @ApiParam("String in group parameters") Integer stringGroup,@HeaderParam("boolean_group") @ApiParam("Boolean in group parameters") Boolean booleanGroup,@QueryParam("int64_group") @ApiParam("Integer in group parameters") Long int64Group);

 @POST
 @Path("/inline-additionalProperties")
 @Consumes({ "application/json" })
 @ApiOperation(value = "test inline additionalProperties", notes = "", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Void.class) })
 Response testInlineAdditionalProperties(@Valid Map<String, String> requestBody);
 Response testInlineAdditionalProperties(@Valid Map<String, String> param);

 @GET
 @Path("/jsonFormData")
Expand All@@ -116,6 +131,13 @@ public interface FakeApi {
 @ApiResponse(code = 200, message = "successful operation", response = Void.class) })
 Response testJsonFormData(@FormParam(value = "param") String param,@FormParam(value = "param2") String param2);

 @PUT
 @Path("/test-query-paramters")
 @ApiOperation(value = "", notes = "To test the collection format in query parameters", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "Success", response = Void.class) })
 Response testQueryParameterCollectionFormat(@QueryParam("pipe") @NotNull List<String> pipe,@QueryParam("ioutil") @NotNull List<String> ioutil,@QueryParam("http") @NotNull List<String> http,@QueryParam("url") @NotNull List<String> url,@QueryParam("context") @NotNull List<String> context);

 @POST
 @Path("/{petId}/uploadImageWithRequiredFile")
 @Consumes({ "multipart/form-data" })
Expand Down

2 changes: 1 addition & 1 deletion
...jaxrs-spec-interface-response/src/gen/java/org/openapitools/api/FakeClassnameTestApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,5 +25,5 @@ public interface FakeClassnameTestApi {
 }, tags={ "fake_classname_tags 123#$%^" })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Client.class) })
 Response testClassname(@Valid Client client);
 Response testClassname(@Valid Client body);
}

13 changes: 8 additions & 5 deletions
...rver/petstore/jaxrs-spec-interface-response/src/gen/java/org/openapitools/api/PetApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,8 +28,9 @@ public interface PetApi {
 })
 }, tags={ "pet", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Void.class),
 @ApiResponse(code = 405, message = "Invalid input", response = Void.class) })
 Response addPet(@Valid Pet pet);
 Response addPet(@Valid Pet body);

 @DELETE
 @Path("/{petId}")
Expand All@@ -40,8 +41,9 @@ public interface PetApi {
 })
 }, tags={ "pet", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Void.class),
 @ApiResponse(code = 400, message = "Invalid pet value", response = Void.class) })
 Response deletePet(@PathParam("petId") @ApiParam("Pet id to delete") Long petId,@HeaderParam("api_key") String apiKey);
 Response deletePet(@PathParam("petId") @ApiParam("Pet id to delete") Long petId,@HeaderParam("api_key") String apiKey);

 @GET
 @Path("/findByStatus")
Expand All@@ -55,7 +57,7 @@ public interface PetApi {
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Pet.class, responseContainer = "List"),
 @ApiResponse(code = 400, message = "Invalid status value", response = Void.class, responseContainer = "List") })
 Response findPetsByStatus(@QueryParam("status") @NotNull @DefaultValue("new ArrayList<String>()")  @ApiParam("Status values that need to be considered for filter") List<String> status);
 Response findPetsByStatus(@QueryParam("status") @NotNull @ApiParam("Status values that need to be considered for filter") List<String> status);

 @GET
 @Path("/findByTags")
Expand All@@ -69,7 +71,7 @@ public interface PetApi {
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Pet.class, responseContainer = "List"),
 @ApiResponse(code = 400, message = "Invalid tag value", response = Void.class, responseContainer = "List") })
 Response findPetsByTags(@QueryParam("tags") @NotNull @DefaultValue("new ArrayList<String>()")  @ApiParam("Tags to filter by") List<String> tags);
 Response findPetsByTags(@QueryParam("tags") @NotNull @ApiParam("Tags to filter by") List<String> tags);

 @GET
 @Path("/{petId}")
Expand All@@ -92,10 +94,11 @@ public interface PetApi {
 })
 }, tags={ "pet", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Void.class),
 @ApiResponse(code = 400, message = "Invalid ID supplied", response = Void.class),
 @ApiResponse(code = 404, message = "Pet not found", response = Void.class),
 @ApiResponse(code = 405, message = "Validation exception", response = Void.class) })
 Response updatePet(@Valid Pet pet);
 Response updatePet(@Valid Pet body);

 @POST
 @Path("/{petId}")
Expand Down

2 changes: 1 addition & 1 deletion
...er/petstore/jaxrs-spec-interface-response/src/gen/java/org/openapitools/api/StoreApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,5 +53,5 @@ public interface StoreApi {
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Order.class),
 @ApiResponse(code = 400, message = "Invalid Order", response = Void.class) })
 Response placeOrder(@Valid Order order);
 Response placeOrder(@Valid Order body);
}
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" + '
[jaxrs-spec] Add builders to models by shybovycha · Pull Request #4916 · OpenAPITools/openapi-generator · GitHub
Skip to content
[jaxrs-spec] Add builders to models#4916

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

 Closed

shybovycha
wants to merge
5
commits into

from

 Closed


[jaxrs-spec] Add builders to models
#4916
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
a9add69

Update formatting in jaxrs-spec POJOs


shybovycha Jan 2, 2020
0ee1f21

Add generateBuilders option

Jan 2, 2020
3d620c8

Update formatting in jaxrs-spec POJOs


shybovycha Jan 2, 2020
e41bf0d

Generate samples

Jan 2, 2020
ccb071f

Disable the builders generation by default

Jan 5, 2020

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


11 changes: 10 additions & 1 deletion
...enerator/src/main/java/org/openapitools/codegen/languages/JavaJAXRSSpecServerCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ public class JavaJAXRSSpecServerCodegen extends AbstractJavaJAXRSServerCodegen {
 public static final String USE_SWAGGER_ANNOTATIONS = "useSwaggerAnnotations";
 public static final String JACKSON = "jackson";
 public static final String OPEN_API_SPEC_FILE_LOCATION = "openApiSpecFileLocation";
 public static final String GENERATE_BUILDERS = "generateBuilders";

 public static final String QUARKUS_LIBRARY = "quarkus";
 public static final String THORNTAIL_LIBRARY = "thorntail";
Expand All@@ -51,6 +52,7 @@ public class JavaJAXRSSpecServerCodegen extends AbstractJavaJAXRSServerCodegen {
 private boolean interfaceOnly = false;
 private boolean returnResponse = false;
 private boolean generatePom = true;
 private boolean generateBuilders = false;
 private boolean useSwaggerAnnotations = true;
 private boolean useJackson = false;
 private String openApiSpecFileLocation = "src/main/openapi/openapi.yaml";
Expand DownExpand Up@@ -102,6 +104,7 @@ public JavaJAXRSSpecServerCodegen() {

 cliOptions.add(library);
 cliOptions.add(CliOption.newBoolean(GENERATE_POM, "Whether to generate pom.xml if the file does not already exist.").defaultValue(String.valueOf(generatePom)));
 cliOptions.add(CliOption.newBoolean(GENERATE_BUILDERS, "Whether to generate builders for models.").defaultValue(String.valueOf(generateBuilders)));
 cliOptions.add(CliOption.newBoolean(INTERFACE_ONLY, "Whether to generate only API interface stubs without the server files.").defaultValue(String.valueOf(interfaceOnly)));
 cliOptions.add(CliOption.newBoolean(RETURN_RESPONSE, "Whether generate API interface should return javax.ws.rs.core.Response instead of a deserialized entity. Only useful if interfaceOnly is true.").defaultValue(String.valueOf(returnResponse)));
 cliOptions.add(CliOption.newBoolean(USE_SWAGGER_ANNOTATIONS, "Whether to generate Swagger annotations.", useSwaggerAnnotations));
Expand All@@ -125,14 +128,20 @@ public void processOpts() {
 additionalProperties.remove(RETURN_RESPONSE);
 }
 }
 if(QUARKUS_LIBRARY.equals(library) || THORNTAIL_LIBRARY.equals(library) || HELIDON_LIBRARY.equals(library) || OPEN_LIBERTY_LIBRARY.equals(library)) {
 if(QUARKUS_LIBRARY.equals(library) || THORNTAIL_LIBRARY.equals(library) || HELIDON_LIBRARY.equals(library) || OPEN_LIBERTY_LIBRARY.equals(library)) {
 useSwaggerAnnotations = false;
 } else {
 if (additionalProperties.containsKey(USE_SWAGGER_ANNOTATIONS)) {
 useSwaggerAnnotations = Boolean.valueOf(additionalProperties.get(USE_SWAGGER_ANNOTATIONS).toString());
 }
 }
 writePropertyBack(USE_SWAGGER_ANNOTATIONS, useSwaggerAnnotations);

 if (additionalProperties.containsKey(GENERATE_BUILDERS)) {
 generateBuilders = Boolean.valueOf(additionalProperties.get(GENERATE_BUILDERS).toString());
 }
 additionalProperties.put(GENERATE_BUILDERS, generateBuilders);

 if (additionalProperties.containsKey(OPEN_API_SPEC_FILE_LOCATION)) {
 openApiSpecFileLocation = additionalProperties.get(OPEN_API_SPEC_FILE_LOCATION).toString();
 } else if(QUARKUS_LIBRARY.equals(library) || THORNTAIL_LIBRARY.equals(library) || HELIDON_LIBRARY.equals(library)) {
Expand Down

71 changes: 45 additions & 26 deletions
modules/openapi-generator/src/main/resources/JavaJaxRS/spec/pojo.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,52 +1,38 @@
{{#useSwaggerAnnotations}}
import io.swagger.annotations.*;
{{/useSwaggerAnnotations}}
{{#useSwaggerAnnotations}}import io.swagger.annotations.*;{{/useSwaggerAnnotations}}
Comment thread
shybovycha marked this conversation as resolved.


Outdated

import java.util.Objects;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;

{{#discriminator}}{{>typeInfoAnnotation}}{{/discriminator}}{{#description}}
/**
{{#discriminator}}{{>typeInfoAnnotation}}{{/discriminator}}{{#description}}/**
 * {{description}}
 **/{{/description}}{{#useSwaggerAnnotations}}
{{#description}}{{>additionalModelTypeAnnotations}}@ApiModel(description = "{{{description}}}"){{/description}}{{/useSwaggerAnnotations}}
 **/{{/description}}
{{#useSwaggerAnnotations}}{{#description}}{{>additionalModelTypeAnnotations}}@ApiModel(description = "{{{description}}}"){{/description}}{{/useSwaggerAnnotations}}
public class {{classname}} {{#parent}}extends {{{parent}}}{{/parent}} {{#serializableModel}}implements Serializable{{/serializableModel}} {
 {{#vars}}{{#isEnum}}{{^isContainer}}

{{>enumClass}}{{/isContainer}}{{#isContainer}}{{#mostInnerItems}}

{{>enumClass}}{{/mostInnerItems}}{{/isContainer}}{{/isEnum}}
 private {{#useBeanValidation}}@Valid{{/useBeanValidation}}{{{datatypeWithEnum}}} {{name}}{{#defaultValue}} = {{{.}}}{{/defaultValue}};{{/vars}}
 private {{#useBeanValidation}}@Valid{{/useBeanValidation}}{{{datatypeWithEnum}}} {{name}}{{#defaultValue}} = {{{.}}}{{/defaultValue}};{{/vars}}

 {{#vars}}
 /**
 {{#description}}
 * {{description}}
 {{/description}}
 {{#minimum}}
 * minimum: {{minimum}}
 {{/minimum}}
 {{#maximum}}
 * maximum: {{maximum}}
 {{/maximum}}
 **/
 public {{classname}} {{name}}({{{datatypeWithEnum}}} {{name}}) {
 {{#generateBuilders}}public {{classname}}({{#vars}}{{{datatypeWithEnum}}} {{name}}{{#hasMore}}, {{/hasMore}}{{/vars}}) {
 {{#vars}}
 this.{{name}} = {{name}};
return this;
{{/vars}}
 }
 {{/generateBuilders}}

 {{#vendorExtensions.extraAnnotation}}{{{vendorExtensions.extraAnnotation}}}{{/vendorExtensions.extraAnnotation}}{{#useSwaggerAnnotations}}
 {{#vars}}{{#vendorExtensions.extraAnnotation}}{{{vendorExtensions.extraAnnotation}}}{{/vendorExtensions.extraAnnotation}}{{#useSwaggerAnnotations}}
 @ApiModelProperty({{#example}}example = "{{{example}}}", {{/example}}{{#required}}required = {{required}}, {{/required}}value = "{{{description}}}"){{/useSwaggerAnnotations}}
 @JsonProperty("{{baseName}}")
{{#useBeanValidation}}{{>beanValidation}}{{/useBeanValidation}} public {{{datatypeWithEnum}}} {{getter}}() {
 return {{name}};
 }

 public void {{setter}}({{{datatypeWithEnum}}} {{name}}) {
 this.{{name}} = {{name}};
 }

 {{/vars}}
 }{{/vars}}

 @Override
 public boolean equals(java.lang.Object o) {
Expand DownExpand Up@@ -88,4 +74,37 @@ public class {{classname}} {{#parent}}extends {{{parent}}}{{/parent}} {{#seriali
 }
 return o.toString().replace("\n", "\n ");
 }

 {{#generateBuilders}}
 public static Builder builder() {
 return new Builder();
 }

 public static class Builder {
 {{#vars}}
 private {{{datatypeWithEnum}}} {{name}}{{#defaultValue}} = {{{.}}}{{/defaultValue}};
 {{/vars}}

 {{#vars}}
 /**
 {{#description}}
 * {{description}}
 {{/description}}
 {{#minimum}}
 * minimum: {{minimum}}
 {{/minimum}}
 {{#maximum}}
 * maximum: {{maximum}}
 {{/maximum}}
 **/
 public Builder {{name}}({{{datatypeWithEnum}}} {{name}}) {
 this.{{name}} = {{name}};
 return this;
 }
 {{/vars}}

 public {{classname}} build() {
 return new {{classname}}({{#vars}}{{name}}{{#hasMore}}, {{/hasMore}}{{/vars}});
 }
 }{{/generateBuilders}}
}

2 changes: 1 addition & 1 deletion
samples/server/petstore/jaxrs-spec-interface-response/.openapi-generator/VERSION

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
3.3.0-SNAPSHOT
4.3.0-SNAPSHOT

2 changes: 1 addition & 1 deletion
...store/jaxrs-spec-interface-response/src/gen/java/org/openapitools/api/AnotherFakeApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,5 +24,5 @@ public interface AnotherFakeApi {
 @ApiOperation(value = "To test special tags", notes = "To test special tags and operation ID starting with number", tags={ "$another-fake?" })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Client.class) })
 Response call123testSpecialTags(@Valid Client client);
 Response call123testSpecialTags(@Valid Client body);
}

34 changes: 28 additions & 6 deletions
...ver/petstore/jaxrs-spec-interface-response/src/gen/java/org/openapitools/api/FakeApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@
import org.openapitools.model.ModelApiResponse;
import org.openapitools.model.OuterComposite;
import org.openapitools.model.User;
import org.openapitools.model.XmlItem;

import javax.ws.rs.*;
import javax.ws.rs.core.Response;
Expand All@@ -26,6 +27,14 @@
@Api(description = "the fake API")
public interface FakeApi {

 @POST
 @Path("/create_xml_item")
 @Consumes({ "application/xml", "application/xml; charset=utf-8", "application/xml; charset=utf-16", "text/xml", "text/xml; charset=utf-8", "text/xml; charset=utf-16" })
 @ApiOperation(value = "creates an XmlItem", notes = "this route creates an XmlItem", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Void.class) })
 Response createXmlItem(@Valid XmlItem xmlItem);

 @POST
 @Path("/outer/boolean")
 @Produces({ "*/*" })
Expand All@@ -40,7 +49,7 @@ public interface FakeApi {
 @ApiOperation(value = "", notes = "Test serialization of object with outer number type", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "Output composite", response = OuterComposite.class) })
 Response fakeOuterCompositeSerialize(@Valid OuterComposite outerComposite);
 Response fakeOuterCompositeSerialize(@Valid OuterComposite body);

 @POST
 @Path("/outer/number")
Expand All@@ -64,23 +73,23 @@ public interface FakeApi {
 @ApiOperation(value = "", notes = "For this test, the body for this request much reference a schema named `File`.", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "Success", response = Void.class) })
 Response testBodyWithFileSchema(@Valid FileSchemaTestClass fileSchemaTestClass);
 Response testBodyWithFileSchema(@Valid FileSchemaTestClass body);

 @PUT
 @Path("/body-with-query-params")
 @Consumes({ "application/json" })
 @ApiOperation(value = "", notes = "", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "Success", response = Void.class) })
 Response testBodyWithQueryParams(@QueryParam("query") @NotNull String query,@Valid User user);
 Response testBodyWithQueryParams(@QueryParam("query") @NotNull String query,@Valid User body);
@wing328wing328Jan 3, 2020

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I noticed that the body parameter name changes from user to body. Likely you're not using the latest (or recent) master when creating this PR.
Please merge the latest master of the official repo into your branch and regenerate the sample again.
@shybovychashybovychaJan 3, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have used 4.3.x as the origin of my branch, are you sure I should merge master in?
@wing328wing328Jan 3, 2020

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK. Please put it on hold. I'll take another look over the weekend or next week.

 @PATCH
 @Consumes({ "application/json" })
 @Produces({ "application/json" })
 @ApiOperation(value = "To test \"client\" model", notes = "To test \"client\" model", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Client.class) })
 Response testClientModel(@Valid Client client);
 Response testClientModel(@Valid Client body);

 @POST
 @Consumes({ "application/x-www-form-urlencoded" })
Expand All@@ -98,15 +107,21 @@ public interface FakeApi {
 @ApiResponses(value = { 
 @ApiResponse(code = 400, message = "Invalid request", response = Void.class),
 @ApiResponse(code = 404, message = "Not found", response = Void.class) })
 Response testEnumParameters(@HeaderParam("enum_header_string_array") @DefaultValue("new ArrayList<String>()") @ApiParam("Header parameter enum test (string array)") List<String> enumHeaderStringArray,@HeaderParam("enum_header_string") @DefaultValue("-efg") @ApiParam("Header parameter enum test (string)") String enumHeaderString,@QueryParam("enum_query_string_array") @DefaultValue("new ArrayList<String>()") @ApiParam("Query parameter enum test (string array)") List<String> enumQueryStringArray,@QueryParam("enum_query_string") @DefaultValue("-efg") @ApiParam("Query parameter enum test (string)") String enumQueryString,@QueryParam("enum_query_integer") @ApiParam("Query parameter enum test (double)") Integer enumQueryInteger,@QueryParam("enum_query_double") @ApiParam("Query parameter enum test (double)") Double enumQueryDouble,@FormParam(value = "enum_form_string_array") List<String> enumFormStringArray,@FormParam(value = "enum_form_string") String enumFormString);
 Response testEnumParameters(@HeaderParam("enum_header_string_array") @DefaultValue("new ArrayList<String>()") @ApiParam("Header parameter enum test (string array)") List<String> enumHeaderStringArray,@HeaderParam("enum_header_string") @DefaultValue("-efg") @ApiParam("Header parameter enum test (string)") String enumHeaderString,@QueryParam("enum_query_string_array") @ApiParam("Query parameter enum test (string array)") List<String> enumQueryStringArray,@QueryParam("enum_query_string") @DefaultValue("-efg") @ApiParam("Query parameter enum test (string)") String enumQueryString,@QueryParam("enum_query_integer") @ApiParam("Query parameter enum test (double)") Integer enumQueryInteger,@QueryParam("enum_query_double") @ApiParam("Query parameter enum test (double)") Double enumQueryDouble,@FormParam(value = "enum_form_string_array") List<String> enumFormStringArray,@FormParam(value = "enum_form_string") String enumFormString);

 @DELETE
 @ApiOperation(value = "Fake endpoint to test group parameters (optional)", notes = "Fake endpoint to test group parameters (optional)", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 400, message = "Someting wrong", response = Void.class) })
 Response testGroupParameters(@QueryParam("required_string_group") @NotNull @ApiParam("Required String in group parameters") Integer requiredStringGroup,@HeaderParam("required_boolean_group") @NotNull @ApiParam("Required Boolean in group parameters") Boolean requiredBooleanGroup,@QueryParam("required_int64_group") @NotNull @ApiParam("Required Integer in group parameters") Long requiredInt64Group,@QueryParam("string_group") @ApiParam("String in group parameters") Integer stringGroup,@HeaderParam("boolean_group") @ApiParam("Boolean in group parameters") Boolean booleanGroup,@QueryParam("int64_group") @ApiParam("Integer in group parameters") Long int64Group);

 @POST
 @Path("/inline-additionalProperties")
 @Consumes({ "application/json" })
 @ApiOperation(value = "test inline additionalProperties", notes = "", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Void.class) })
 Response testInlineAdditionalProperties(@Valid Map<String, String> requestBody);
 Response testInlineAdditionalProperties(@Valid Map<String, String> param);

 @GET
 @Path("/jsonFormData")
Expand All@@ -116,6 +131,13 @@ public interface FakeApi {
 @ApiResponse(code = 200, message = "successful operation", response = Void.class) })
 Response testJsonFormData(@FormParam(value = "param") String param,@FormParam(value = "param2") String param2);

 @PUT
 @Path("/test-query-paramters")
 @ApiOperation(value = "", notes = "To test the collection format in query parameters", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "Success", response = Void.class) })
 Response testQueryParameterCollectionFormat(@QueryParam("pipe") @NotNull List<String> pipe,@QueryParam("ioutil") @NotNull List<String> ioutil,@QueryParam("http") @NotNull List<String> http,@QueryParam("url") @NotNull List<String> url,@QueryParam("context") @NotNull List<String> context);

 @POST
 @Path("/{petId}/uploadImageWithRequiredFile")
 @Consumes({ "multipart/form-data" })
Expand Down

2 changes: 1 addition & 1 deletion
...jaxrs-spec-interface-response/src/gen/java/org/openapitools/api/FakeClassnameTestApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,5 +25,5 @@ public interface FakeClassnameTestApi {
 }, tags={ "fake_classname_tags 123#$%^" })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Client.class) })
 Response testClassname(@Valid Client client);
 Response testClassname(@Valid Client body);
}

13 changes: 8 additions & 5 deletions
...rver/petstore/jaxrs-spec-interface-response/src/gen/java/org/openapitools/api/PetApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,8 +28,9 @@ public interface PetApi {
 })
 }, tags={ "pet", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Void.class),
 @ApiResponse(code = 405, message = "Invalid input", response = Void.class) })
 Response addPet(@Valid Pet pet);
 Response addPet(@Valid Pet body);

 @DELETE
 @Path("/{petId}")
Expand All@@ -40,8 +41,9 @@ public interface PetApi {
 })
 }, tags={ "pet", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Void.class),
 @ApiResponse(code = 400, message = "Invalid pet value", response = Void.class) })
 Response deletePet(@PathParam("petId") @ApiParam("Pet id to delete") Long petId,@HeaderParam("api_key") String apiKey);
 Response deletePet(@PathParam("petId") @ApiParam("Pet id to delete") Long petId,@HeaderParam("api_key") String apiKey);

 @GET
 @Path("/findByStatus")
Expand All@@ -55,7 +57,7 @@ public interface PetApi {
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Pet.class, responseContainer = "List"),
 @ApiResponse(code = 400, message = "Invalid status value", response = Void.class, responseContainer = "List") })
 Response findPetsByStatus(@QueryParam("status") @NotNull @DefaultValue("new ArrayList<String>()")  @ApiParam("Status values that need to be considered for filter") List<String> status);
 Response findPetsByStatus(@QueryParam("status") @NotNull @ApiParam("Status values that need to be considered for filter") List<String> status);

 @GET
 @Path("/findByTags")
Expand All@@ -69,7 +71,7 @@ public interface PetApi {
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Pet.class, responseContainer = "List"),
 @ApiResponse(code = 400, message = "Invalid tag value", response = Void.class, responseContainer = "List") })
 Response findPetsByTags(@QueryParam("tags") @NotNull @DefaultValue("new ArrayList<String>()")  @ApiParam("Tags to filter by") List<String> tags);
 Response findPetsByTags(@QueryParam("tags") @NotNull @ApiParam("Tags to filter by") List<String> tags);

 @GET
 @Path("/{petId}")
Expand All@@ -92,10 +94,11 @@ public interface PetApi {
 })
 }, tags={ "pet", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Void.class),
 @ApiResponse(code = 400, message = "Invalid ID supplied", response = Void.class),
 @ApiResponse(code = 404, message = "Pet not found", response = Void.class),
 @ApiResponse(code = 405, message = "Validation exception", response = Void.class) })
 Response updatePet(@Valid Pet pet);
 Response updatePet(@Valid Pet body);

 @POST
 @Path("/{petId}")
Expand Down

2 changes: 1 addition & 1 deletion
...er/petstore/jaxrs-spec-interface-response/src/gen/java/org/openapitools/api/StoreApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,5 +53,5 @@ public interface StoreApi {
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Order.class),
 @ApiResponse(code = 400, message = "Invalid Order", response = Void.class) })
 Response placeOrder(@Valid Order order);
 Response placeOrder(@Valid Order body);
}
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('^' + ".*" + '
[jaxrs-spec] Add builders to models by shybovycha · Pull Request #4916 · OpenAPITools/openapi-generator · GitHub
Skip to content
[jaxrs-spec] Add builders to models#4916

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

 Closed

shybovycha
wants to merge
5
commits into

from

 Closed


[jaxrs-spec] Add builders to models
#4916
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
a9add69

Update formatting in jaxrs-spec POJOs


shybovycha Jan 2, 2020
0ee1f21

Add generateBuilders option

Jan 2, 2020
3d620c8

Update formatting in jaxrs-spec POJOs


shybovycha Jan 2, 2020
e41bf0d

Generate samples

Jan 2, 2020
ccb071f

Disable the builders generation by default

Jan 5, 2020

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


11 changes: 10 additions & 1 deletion
...enerator/src/main/java/org/openapitools/codegen/languages/JavaJAXRSSpecServerCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ public class JavaJAXRSSpecServerCodegen extends AbstractJavaJAXRSServerCodegen {
 public static final String USE_SWAGGER_ANNOTATIONS = "useSwaggerAnnotations";
 public static final String JACKSON = "jackson";
 public static final String OPEN_API_SPEC_FILE_LOCATION = "openApiSpecFileLocation";
 public static final String GENERATE_BUILDERS = "generateBuilders";

 public static final String QUARKUS_LIBRARY = "quarkus";
 public static final String THORNTAIL_LIBRARY = "thorntail";
Expand All@@ -51,6 +52,7 @@ public class JavaJAXRSSpecServerCodegen extends AbstractJavaJAXRSServerCodegen {
 private boolean interfaceOnly = false;
 private boolean returnResponse = false;
 private boolean generatePom = true;
 private boolean generateBuilders = false;
 private boolean useSwaggerAnnotations = true;
 private boolean useJackson = false;
 private String openApiSpecFileLocation = "src/main/openapi/openapi.yaml";
Expand DownExpand Up@@ -102,6 +104,7 @@ public JavaJAXRSSpecServerCodegen() {

 cliOptions.add(library);
 cliOptions.add(CliOption.newBoolean(GENERATE_POM, "Whether to generate pom.xml if the file does not already exist.").defaultValue(String.valueOf(generatePom)));
 cliOptions.add(CliOption.newBoolean(GENERATE_BUILDERS, "Whether to generate builders for models.").defaultValue(String.valueOf(generateBuilders)));
 cliOptions.add(CliOption.newBoolean(INTERFACE_ONLY, "Whether to generate only API interface stubs without the server files.").defaultValue(String.valueOf(interfaceOnly)));
 cliOptions.add(CliOption.newBoolean(RETURN_RESPONSE, "Whether generate API interface should return javax.ws.rs.core.Response instead of a deserialized entity. Only useful if interfaceOnly is true.").defaultValue(String.valueOf(returnResponse)));
 cliOptions.add(CliOption.newBoolean(USE_SWAGGER_ANNOTATIONS, "Whether to generate Swagger annotations.", useSwaggerAnnotations));
Expand All@@ -125,14 +128,20 @@ public void processOpts() {
 additionalProperties.remove(RETURN_RESPONSE);
 }
 }
 if(QUARKUS_LIBRARY.equals(library) || THORNTAIL_LIBRARY.equals(library) || HELIDON_LIBRARY.equals(library) || OPEN_LIBERTY_LIBRARY.equals(library)) {
 if(QUARKUS_LIBRARY.equals(library) || THORNTAIL_LIBRARY.equals(library) || HELIDON_LIBRARY.equals(library) || OPEN_LIBERTY_LIBRARY.equals(library)) {
 useSwaggerAnnotations = false;
 } else {
 if (additionalProperties.containsKey(USE_SWAGGER_ANNOTATIONS)) {
 useSwaggerAnnotations = Boolean.valueOf(additionalProperties.get(USE_SWAGGER_ANNOTATIONS).toString());
 }
 }
 writePropertyBack(USE_SWAGGER_ANNOTATIONS, useSwaggerAnnotations);

 if (additionalProperties.containsKey(GENERATE_BUILDERS)) {
 generateBuilders = Boolean.valueOf(additionalProperties.get(GENERATE_BUILDERS).toString());
 }
 additionalProperties.put(GENERATE_BUILDERS, generateBuilders);

 if (additionalProperties.containsKey(OPEN_API_SPEC_FILE_LOCATION)) {
 openApiSpecFileLocation = additionalProperties.get(OPEN_API_SPEC_FILE_LOCATION).toString();
 } else if(QUARKUS_LIBRARY.equals(library) || THORNTAIL_LIBRARY.equals(library) || HELIDON_LIBRARY.equals(library)) {
Expand Down

71 changes: 45 additions & 26 deletions
modules/openapi-generator/src/main/resources/JavaJaxRS/spec/pojo.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,52 +1,38 @@
{{#useSwaggerAnnotations}}
import io.swagger.annotations.*;
{{/useSwaggerAnnotations}}
{{#useSwaggerAnnotations}}import io.swagger.annotations.*;{{/useSwaggerAnnotations}}
Comment thread
shybovycha marked this conversation as resolved.


Outdated

import java.util.Objects;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;

{{#discriminator}}{{>typeInfoAnnotation}}{{/discriminator}}{{#description}}
/**
{{#discriminator}}{{>typeInfoAnnotation}}{{/discriminator}}{{#description}}/**
 * {{description}}
 **/{{/description}}{{#useSwaggerAnnotations}}
{{#description}}{{>additionalModelTypeAnnotations}}@ApiModel(description = "{{{description}}}"){{/description}}{{/useSwaggerAnnotations}}
 **/{{/description}}
{{#useSwaggerAnnotations}}{{#description}}{{>additionalModelTypeAnnotations}}@ApiModel(description = "{{{description}}}"){{/description}}{{/useSwaggerAnnotations}}
public class {{classname}} {{#parent}}extends {{{parent}}}{{/parent}} {{#serializableModel}}implements Serializable{{/serializableModel}} {
 {{#vars}}{{#isEnum}}{{^isContainer}}

{{>enumClass}}{{/isContainer}}{{#isContainer}}{{#mostInnerItems}}

{{>enumClass}}{{/mostInnerItems}}{{/isContainer}}{{/isEnum}}
 private {{#useBeanValidation}}@Valid{{/useBeanValidation}}{{{datatypeWithEnum}}} {{name}}{{#defaultValue}} = {{{.}}}{{/defaultValue}};{{/vars}}
 private {{#useBeanValidation}}@Valid{{/useBeanValidation}}{{{datatypeWithEnum}}} {{name}}{{#defaultValue}} = {{{.}}}{{/defaultValue}};{{/vars}}

 {{#vars}}
 /**
 {{#description}}
 * {{description}}
 {{/description}}
 {{#minimum}}
 * minimum: {{minimum}}
 {{/minimum}}
 {{#maximum}}
 * maximum: {{maximum}}
 {{/maximum}}
 **/
 public {{classname}} {{name}}({{{datatypeWithEnum}}} {{name}}) {
 {{#generateBuilders}}public {{classname}}({{#vars}}{{{datatypeWithEnum}}} {{name}}{{#hasMore}}, {{/hasMore}}{{/vars}}) {
 {{#vars}}
 this.{{name}} = {{name}};
return this;
{{/vars}}
 }
 {{/generateBuilders}}

 {{#vendorExtensions.extraAnnotation}}{{{vendorExtensions.extraAnnotation}}}{{/vendorExtensions.extraAnnotation}}{{#useSwaggerAnnotations}}
 {{#vars}}{{#vendorExtensions.extraAnnotation}}{{{vendorExtensions.extraAnnotation}}}{{/vendorExtensions.extraAnnotation}}{{#useSwaggerAnnotations}}
 @ApiModelProperty({{#example}}example = "{{{example}}}", {{/example}}{{#required}}required = {{required}}, {{/required}}value = "{{{description}}}"){{/useSwaggerAnnotations}}
 @JsonProperty("{{baseName}}")
{{#useBeanValidation}}{{>beanValidation}}{{/useBeanValidation}} public {{{datatypeWithEnum}}} {{getter}}() {
 return {{name}};
 }

 public void {{setter}}({{{datatypeWithEnum}}} {{name}}) {
 this.{{name}} = {{name}};
 }

 {{/vars}}
 }{{/vars}}

 @Override
 public boolean equals(java.lang.Object o) {
Expand DownExpand Up@@ -88,4 +74,37 @@ public class {{classname}} {{#parent}}extends {{{parent}}}{{/parent}} {{#seriali
 }
 return o.toString().replace("\n", "\n ");
 }

 {{#generateBuilders}}
 public static Builder builder() {
 return new Builder();
 }

 public static class Builder {
 {{#vars}}
 private {{{datatypeWithEnum}}} {{name}}{{#defaultValue}} = {{{.}}}{{/defaultValue}};
 {{/vars}}

 {{#vars}}
 /**
 {{#description}}
 * {{description}}
 {{/description}}
 {{#minimum}}
 * minimum: {{minimum}}
 {{/minimum}}
 {{#maximum}}
 * maximum: {{maximum}}
 {{/maximum}}
 **/
 public Builder {{name}}({{{datatypeWithEnum}}} {{name}}) {
 this.{{name}} = {{name}};
 return this;
 }
 {{/vars}}

 public {{classname}} build() {
 return new {{classname}}({{#vars}}{{name}}{{#hasMore}}, {{/hasMore}}{{/vars}});
 }
 }{{/generateBuilders}}
}

2 changes: 1 addition & 1 deletion
samples/server/petstore/jaxrs-spec-interface-response/.openapi-generator/VERSION

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
3.3.0-SNAPSHOT
4.3.0-SNAPSHOT

2 changes: 1 addition & 1 deletion
...store/jaxrs-spec-interface-response/src/gen/java/org/openapitools/api/AnotherFakeApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,5 +24,5 @@ public interface AnotherFakeApi {
 @ApiOperation(value = "To test special tags", notes = "To test special tags and operation ID starting with number", tags={ "$another-fake?" })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Client.class) })
 Response call123testSpecialTags(@Valid Client client);
 Response call123testSpecialTags(@Valid Client body);
}

34 changes: 28 additions & 6 deletions
...ver/petstore/jaxrs-spec-interface-response/src/gen/java/org/openapitools/api/FakeApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@
import org.openapitools.model.ModelApiResponse;
import org.openapitools.model.OuterComposite;
import org.openapitools.model.User;
import org.openapitools.model.XmlItem;

import javax.ws.rs.*;
import javax.ws.rs.core.Response;
Expand All@@ -26,6 +27,14 @@
@Api(description = "the fake API")
public interface FakeApi {

 @POST
 @Path("/create_xml_item")
 @Consumes({ "application/xml", "application/xml; charset=utf-8", "application/xml; charset=utf-16", "text/xml", "text/xml; charset=utf-8", "text/xml; charset=utf-16" })
 @ApiOperation(value = "creates an XmlItem", notes = "this route creates an XmlItem", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Void.class) })
 Response createXmlItem(@Valid XmlItem xmlItem);

 @POST
 @Path("/outer/boolean")
 @Produces({ "*/*" })
Expand All@@ -40,7 +49,7 @@ public interface FakeApi {
 @ApiOperation(value = "", notes = "Test serialization of object with outer number type", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "Output composite", response = OuterComposite.class) })
 Response fakeOuterCompositeSerialize(@Valid OuterComposite outerComposite);
 Response fakeOuterCompositeSerialize(@Valid OuterComposite body);

 @POST
 @Path("/outer/number")
Expand All@@ -64,23 +73,23 @@ public interface FakeApi {
 @ApiOperation(value = "", notes = "For this test, the body for this request much reference a schema named `File`.", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "Success", response = Void.class) })
 Response testBodyWithFileSchema(@Valid FileSchemaTestClass fileSchemaTestClass);
 Response testBodyWithFileSchema(@Valid FileSchemaTestClass body);

 @PUT
 @Path("/body-with-query-params")
 @Consumes({ "application/json" })
 @ApiOperation(value = "", notes = "", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "Success", response = Void.class) })
 Response testBodyWithQueryParams(@QueryParam("query") @NotNull String query,@Valid User user);
 Response testBodyWithQueryParams(@QueryParam("query") @NotNull String query,@Valid User body);
@wing328wing328Jan 3, 2020

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I noticed that the body parameter name changes from user to body. Likely you're not using the latest (or recent) master when creating this PR.
Please merge the latest master of the official repo into your branch and regenerate the sample again.
@shybovychashybovychaJan 3, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have used 4.3.x as the origin of my branch, are you sure I should merge master in?
@wing328wing328Jan 3, 2020

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK. Please put it on hold. I'll take another look over the weekend or next week.

 @PATCH
 @Consumes({ "application/json" })
 @Produces({ "application/json" })
 @ApiOperation(value = "To test \"client\" model", notes = "To test \"client\" model", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Client.class) })
 Response testClientModel(@Valid Client client);
 Response testClientModel(@Valid Client body);

 @POST
 @Consumes({ "application/x-www-form-urlencoded" })
Expand All@@ -98,15 +107,21 @@ public interface FakeApi {
 @ApiResponses(value = { 
 @ApiResponse(code = 400, message = "Invalid request", response = Void.class),
 @ApiResponse(code = 404, message = "Not found", response = Void.class) })
 Response testEnumParameters(@HeaderParam("enum_header_string_array") @DefaultValue("new ArrayList<String>()") @ApiParam("Header parameter enum test (string array)") List<String> enumHeaderStringArray,@HeaderParam("enum_header_string") @DefaultValue("-efg") @ApiParam("Header parameter enum test (string)") String enumHeaderString,@QueryParam("enum_query_string_array") @DefaultValue("new ArrayList<String>()") @ApiParam("Query parameter enum test (string array)") List<String> enumQueryStringArray,@QueryParam("enum_query_string") @DefaultValue("-efg") @ApiParam("Query parameter enum test (string)") String enumQueryString,@QueryParam("enum_query_integer") @ApiParam("Query parameter enum test (double)") Integer enumQueryInteger,@QueryParam("enum_query_double") @ApiParam("Query parameter enum test (double)") Double enumQueryDouble,@FormParam(value = "enum_form_string_array") List<String> enumFormStringArray,@FormParam(value = "enum_form_string") String enumFormString);
 Response testEnumParameters(@HeaderParam("enum_header_string_array") @DefaultValue("new ArrayList<String>()") @ApiParam("Header parameter enum test (string array)") List<String> enumHeaderStringArray,@HeaderParam("enum_header_string") @DefaultValue("-efg") @ApiParam("Header parameter enum test (string)") String enumHeaderString,@QueryParam("enum_query_string_array") @ApiParam("Query parameter enum test (string array)") List<String> enumQueryStringArray,@QueryParam("enum_query_string") @DefaultValue("-efg") @ApiParam("Query parameter enum test (string)") String enumQueryString,@QueryParam("enum_query_integer") @ApiParam("Query parameter enum test (double)") Integer enumQueryInteger,@QueryParam("enum_query_double") @ApiParam("Query parameter enum test (double)") Double enumQueryDouble,@FormParam(value = "enum_form_string_array") List<String> enumFormStringArray,@FormParam(value = "enum_form_string") String enumFormString);

 @DELETE
 @ApiOperation(value = "Fake endpoint to test group parameters (optional)", notes = "Fake endpoint to test group parameters (optional)", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 400, message = "Someting wrong", response = Void.class) })
 Response testGroupParameters(@QueryParam("required_string_group") @NotNull @ApiParam("Required String in group parameters") Integer requiredStringGroup,@HeaderParam("required_boolean_group") @NotNull @ApiParam("Required Boolean in group parameters") Boolean requiredBooleanGroup,@QueryParam("required_int64_group") @NotNull @ApiParam("Required Integer in group parameters") Long requiredInt64Group,@QueryParam("string_group") @ApiParam("String in group parameters") Integer stringGroup,@HeaderParam("boolean_group") @ApiParam("Boolean in group parameters") Boolean booleanGroup,@QueryParam("int64_group") @ApiParam("Integer in group parameters") Long int64Group);

 @POST
 @Path("/inline-additionalProperties")
 @Consumes({ "application/json" })
 @ApiOperation(value = "test inline additionalProperties", notes = "", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Void.class) })
 Response testInlineAdditionalProperties(@Valid Map<String, String> requestBody);
 Response testInlineAdditionalProperties(@Valid Map<String, String> param);

 @GET
 @Path("/jsonFormData")
Expand All@@ -116,6 +131,13 @@ public interface FakeApi {
 @ApiResponse(code = 200, message = "successful operation", response = Void.class) })
 Response testJsonFormData(@FormParam(value = "param") String param,@FormParam(value = "param2") String param2);

 @PUT
 @Path("/test-query-paramters")
 @ApiOperation(value = "", notes = "To test the collection format in query parameters", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "Success", response = Void.class) })
 Response testQueryParameterCollectionFormat(@QueryParam("pipe") @NotNull List<String> pipe,@QueryParam("ioutil") @NotNull List<String> ioutil,@QueryParam("http") @NotNull List<String> http,@QueryParam("url") @NotNull List<String> url,@QueryParam("context") @NotNull List<String> context);

 @POST
 @Path("/{petId}/uploadImageWithRequiredFile")
 @Consumes({ "multipart/form-data" })
Expand Down

2 changes: 1 addition & 1 deletion
...jaxrs-spec-interface-response/src/gen/java/org/openapitools/api/FakeClassnameTestApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,5 +25,5 @@ public interface FakeClassnameTestApi {
 }, tags={ "fake_classname_tags 123#$%^" })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Client.class) })
 Response testClassname(@Valid Client client);
 Response testClassname(@Valid Client body);
}

13 changes: 8 additions & 5 deletions
...rver/petstore/jaxrs-spec-interface-response/src/gen/java/org/openapitools/api/PetApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,8 +28,9 @@ public interface PetApi {
 })
 }, tags={ "pet", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Void.class),
 @ApiResponse(code = 405, message = "Invalid input", response = Void.class) })
 Response addPet(@Valid Pet pet);
 Response addPet(@Valid Pet body);

 @DELETE
 @Path("/{petId}")
Expand All@@ -40,8 +41,9 @@ public interface PetApi {
 })
 }, tags={ "pet", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Void.class),
 @ApiResponse(code = 400, message = "Invalid pet value", response = Void.class) })
 Response deletePet(@PathParam("petId") @ApiParam("Pet id to delete") Long petId,@HeaderParam("api_key") String apiKey);
 Response deletePet(@PathParam("petId") @ApiParam("Pet id to delete") Long petId,@HeaderParam("api_key") String apiKey);

 @GET
 @Path("/findByStatus")
Expand All@@ -55,7 +57,7 @@ public interface PetApi {
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Pet.class, responseContainer = "List"),
 @ApiResponse(code = 400, message = "Invalid status value", response = Void.class, responseContainer = "List") })
 Response findPetsByStatus(@QueryParam("status") @NotNull @DefaultValue("new ArrayList<String>()")  @ApiParam("Status values that need to be considered for filter") List<String> status);
 Response findPetsByStatus(@QueryParam("status") @NotNull @ApiParam("Status values that need to be considered for filter") List<String> status);

 @GET
 @Path("/findByTags")
Expand All@@ -69,7 +71,7 @@ public interface PetApi {
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Pet.class, responseContainer = "List"),
 @ApiResponse(code = 400, message = "Invalid tag value", response = Void.class, responseContainer = "List") })
 Response findPetsByTags(@QueryParam("tags") @NotNull @DefaultValue("new ArrayList<String>()")  @ApiParam("Tags to filter by") List<String> tags);
 Response findPetsByTags(@QueryParam("tags") @NotNull @ApiParam("Tags to filter by") List<String> tags);

 @GET
 @Path("/{petId}")
Expand All@@ -92,10 +94,11 @@ public interface PetApi {
 })
 }, tags={ "pet", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Void.class),
 @ApiResponse(code = 400, message = "Invalid ID supplied", response = Void.class),
 @ApiResponse(code = 404, message = "Pet not found", response = Void.class),
 @ApiResponse(code = 405, message = "Validation exception", response = Void.class) })
 Response updatePet(@Valid Pet pet);
 Response updatePet(@Valid Pet body);

 @POST
 @Path("/{petId}")
Expand Down

2 changes: 1 addition & 1 deletion
...er/petstore/jaxrs-spec-interface-response/src/gen/java/org/openapitools/api/StoreApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,5 +53,5 @@ public interface StoreApi {
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Order.class),
 @ApiResponse(code = 400, message = "Invalid Order", response = Void.class) })
 Response placeOrder(@Valid Order order);
 Response placeOrder(@Valid Order body);
}
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('^' + ".*" + '
[jaxrs-spec] Add builders to models by shybovycha · Pull Request #4916 · OpenAPITools/openapi-generator · GitHub
Skip to content
[jaxrs-spec] Add builders to models#4916

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

 Closed

shybovycha
wants to merge
5
commits into

from

 Closed


[jaxrs-spec] Add builders to models
#4916
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
a9add69

Update formatting in jaxrs-spec POJOs


shybovycha Jan 2, 2020
0ee1f21

Add generateBuilders option

Jan 2, 2020
3d620c8

Update formatting in jaxrs-spec POJOs


shybovycha Jan 2, 2020
e41bf0d

Generate samples

Jan 2, 2020
ccb071f

Disable the builders generation by default

Jan 5, 2020

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


11 changes: 10 additions & 1 deletion
...enerator/src/main/java/org/openapitools/codegen/languages/JavaJAXRSSpecServerCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ public class JavaJAXRSSpecServerCodegen extends AbstractJavaJAXRSServerCodegen {
 public static final String USE_SWAGGER_ANNOTATIONS = "useSwaggerAnnotations";
 public static final String JACKSON = "jackson";
 public static final String OPEN_API_SPEC_FILE_LOCATION = "openApiSpecFileLocation";
 public static final String GENERATE_BUILDERS = "generateBuilders";

 public static final String QUARKUS_LIBRARY = "quarkus";
 public static final String THORNTAIL_LIBRARY = "thorntail";
Expand All@@ -51,6 +52,7 @@ public class JavaJAXRSSpecServerCodegen extends AbstractJavaJAXRSServerCodegen {
 private boolean interfaceOnly = false;
 private boolean returnResponse = false;
 private boolean generatePom = true;
 private boolean generateBuilders = false;
 private boolean useSwaggerAnnotations = true;
 private boolean useJackson = false;
 private String openApiSpecFileLocation = "src/main/openapi/openapi.yaml";
Expand DownExpand Up@@ -102,6 +104,7 @@ public JavaJAXRSSpecServerCodegen() {

 cliOptions.add(library);
 cliOptions.add(CliOption.newBoolean(GENERATE_POM, "Whether to generate pom.xml if the file does not already exist.").defaultValue(String.valueOf(generatePom)));
 cliOptions.add(CliOption.newBoolean(GENERATE_BUILDERS, "Whether to generate builders for models.").defaultValue(String.valueOf(generateBuilders)));
 cliOptions.add(CliOption.newBoolean(INTERFACE_ONLY, "Whether to generate only API interface stubs without the server files.").defaultValue(String.valueOf(interfaceOnly)));
 cliOptions.add(CliOption.newBoolean(RETURN_RESPONSE, "Whether generate API interface should return javax.ws.rs.core.Response instead of a deserialized entity. Only useful if interfaceOnly is true.").defaultValue(String.valueOf(returnResponse)));
 cliOptions.add(CliOption.newBoolean(USE_SWAGGER_ANNOTATIONS, "Whether to generate Swagger annotations.", useSwaggerAnnotations));
Expand All@@ -125,14 +128,20 @@ public void processOpts() {
 additionalProperties.remove(RETURN_RESPONSE);
 }
 }
 if(QUARKUS_LIBRARY.equals(library) || THORNTAIL_LIBRARY.equals(library) || HELIDON_LIBRARY.equals(library) || OPEN_LIBERTY_LIBRARY.equals(library)) {
 if(QUARKUS_LIBRARY.equals(library) || THORNTAIL_LIBRARY.equals(library) || HELIDON_LIBRARY.equals(library) || OPEN_LIBERTY_LIBRARY.equals(library)) {
 useSwaggerAnnotations = false;
 } else {
 if (additionalProperties.containsKey(USE_SWAGGER_ANNOTATIONS)) {
 useSwaggerAnnotations = Boolean.valueOf(additionalProperties.get(USE_SWAGGER_ANNOTATIONS).toString());
 }
 }
 writePropertyBack(USE_SWAGGER_ANNOTATIONS, useSwaggerAnnotations);

 if (additionalProperties.containsKey(GENERATE_BUILDERS)) {
 generateBuilders = Boolean.valueOf(additionalProperties.get(GENERATE_BUILDERS).toString());
 }
 additionalProperties.put(GENERATE_BUILDERS, generateBuilders);

 if (additionalProperties.containsKey(OPEN_API_SPEC_FILE_LOCATION)) {
 openApiSpecFileLocation = additionalProperties.get(OPEN_API_SPEC_FILE_LOCATION).toString();
 } else if(QUARKUS_LIBRARY.equals(library) || THORNTAIL_LIBRARY.equals(library) || HELIDON_LIBRARY.equals(library)) {
Expand Down

71 changes: 45 additions & 26 deletions
modules/openapi-generator/src/main/resources/JavaJaxRS/spec/pojo.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,52 +1,38 @@
{{#useSwaggerAnnotations}}
import io.swagger.annotations.*;
{{/useSwaggerAnnotations}}
{{#useSwaggerAnnotations}}import io.swagger.annotations.*;{{/useSwaggerAnnotations}}
Comment thread
shybovycha marked this conversation as resolved.


Outdated

import java.util.Objects;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;

{{#discriminator}}{{>typeInfoAnnotation}}{{/discriminator}}{{#description}}
/**
{{#discriminator}}{{>typeInfoAnnotation}}{{/discriminator}}{{#description}}/**
 * {{description}}
 **/{{/description}}{{#useSwaggerAnnotations}}
{{#description}}{{>additionalModelTypeAnnotations}}@ApiModel(description = "{{{description}}}"){{/description}}{{/useSwaggerAnnotations}}
 **/{{/description}}
{{#useSwaggerAnnotations}}{{#description}}{{>additionalModelTypeAnnotations}}@ApiModel(description = "{{{description}}}"){{/description}}{{/useSwaggerAnnotations}}
public class {{classname}} {{#parent}}extends {{{parent}}}{{/parent}} {{#serializableModel}}implements Serializable{{/serializableModel}} {
 {{#vars}}{{#isEnum}}{{^isContainer}}

{{>enumClass}}{{/isContainer}}{{#isContainer}}{{#mostInnerItems}}

{{>enumClass}}{{/mostInnerItems}}{{/isContainer}}{{/isEnum}}
 private {{#useBeanValidation}}@Valid{{/useBeanValidation}}{{{datatypeWithEnum}}} {{name}}{{#defaultValue}} = {{{.}}}{{/defaultValue}};{{/vars}}
 private {{#useBeanValidation}}@Valid{{/useBeanValidation}}{{{datatypeWithEnum}}} {{name}}{{#defaultValue}} = {{{.}}}{{/defaultValue}};{{/vars}}

 {{#vars}}
 /**
 {{#description}}
 * {{description}}
 {{/description}}
 {{#minimum}}
 * minimum: {{minimum}}
 {{/minimum}}
 {{#maximum}}
 * maximum: {{maximum}}
 {{/maximum}}
 **/
 public {{classname}} {{name}}({{{datatypeWithEnum}}} {{name}}) {
 {{#generateBuilders}}public {{classname}}({{#vars}}{{{datatypeWithEnum}}} {{name}}{{#hasMore}}, {{/hasMore}}{{/vars}}) {
 {{#vars}}
 this.{{name}} = {{name}};
return this;
{{/vars}}
 }
 {{/generateBuilders}}

 {{#vendorExtensions.extraAnnotation}}{{{vendorExtensions.extraAnnotation}}}{{/vendorExtensions.extraAnnotation}}{{#useSwaggerAnnotations}}
 {{#vars}}{{#vendorExtensions.extraAnnotation}}{{{vendorExtensions.extraAnnotation}}}{{/vendorExtensions.extraAnnotation}}{{#useSwaggerAnnotations}}
 @ApiModelProperty({{#example}}example = "{{{example}}}", {{/example}}{{#required}}required = {{required}}, {{/required}}value = "{{{description}}}"){{/useSwaggerAnnotations}}
 @JsonProperty("{{baseName}}")
{{#useBeanValidation}}{{>beanValidation}}{{/useBeanValidation}} public {{{datatypeWithEnum}}} {{getter}}() {
 return {{name}};
 }

 public void {{setter}}({{{datatypeWithEnum}}} {{name}}) {
 this.{{name}} = {{name}};
 }

 {{/vars}}
 }{{/vars}}

 @Override
 public boolean equals(java.lang.Object o) {
Expand DownExpand Up@@ -88,4 +74,37 @@ public class {{classname}} {{#parent}}extends {{{parent}}}{{/parent}} {{#seriali
 }
 return o.toString().replace("\n", "\n ");
 }

 {{#generateBuilders}}
 public static Builder builder() {
 return new Builder();
 }

 public static class Builder {
 {{#vars}}
 private {{{datatypeWithEnum}}} {{name}}{{#defaultValue}} = {{{.}}}{{/defaultValue}};
 {{/vars}}

 {{#vars}}
 /**
 {{#description}}
 * {{description}}
 {{/description}}
 {{#minimum}}
 * minimum: {{minimum}}
 {{/minimum}}
 {{#maximum}}
 * maximum: {{maximum}}
 {{/maximum}}
 **/
 public Builder {{name}}({{{datatypeWithEnum}}} {{name}}) {
 this.{{name}} = {{name}};
 return this;
 }
 {{/vars}}

 public {{classname}} build() {
 return new {{classname}}({{#vars}}{{name}}{{#hasMore}}, {{/hasMore}}{{/vars}});
 }
 }{{/generateBuilders}}
}

2 changes: 1 addition & 1 deletion
samples/server/petstore/jaxrs-spec-interface-response/.openapi-generator/VERSION

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
3.3.0-SNAPSHOT
4.3.0-SNAPSHOT

2 changes: 1 addition & 1 deletion
...store/jaxrs-spec-interface-response/src/gen/java/org/openapitools/api/AnotherFakeApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,5 +24,5 @@ public interface AnotherFakeApi {
 @ApiOperation(value = "To test special tags", notes = "To test special tags and operation ID starting with number", tags={ "$another-fake?" })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Client.class) })
 Response call123testSpecialTags(@Valid Client client);
 Response call123testSpecialTags(@Valid Client body);
}

34 changes: 28 additions & 6 deletions
...ver/petstore/jaxrs-spec-interface-response/src/gen/java/org/openapitools/api/FakeApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@
import org.openapitools.model.ModelApiResponse;
import org.openapitools.model.OuterComposite;
import org.openapitools.model.User;
import org.openapitools.model.XmlItem;

import javax.ws.rs.*;
import javax.ws.rs.core.Response;
Expand All@@ -26,6 +27,14 @@
@Api(description = "the fake API")
public interface FakeApi {

 @POST
 @Path("/create_xml_item")
 @Consumes({ "application/xml", "application/xml; charset=utf-8", "application/xml; charset=utf-16", "text/xml", "text/xml; charset=utf-8", "text/xml; charset=utf-16" })
 @ApiOperation(value = "creates an XmlItem", notes = "this route creates an XmlItem", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Void.class) })
 Response createXmlItem(@Valid XmlItem xmlItem);

 @POST
 @Path("/outer/boolean")
 @Produces({ "*/*" })
Expand All@@ -40,7 +49,7 @@ public interface FakeApi {
 @ApiOperation(value = "", notes = "Test serialization of object with outer number type", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "Output composite", response = OuterComposite.class) })
 Response fakeOuterCompositeSerialize(@Valid OuterComposite outerComposite);
 Response fakeOuterCompositeSerialize(@Valid OuterComposite body);

 @POST
 @Path("/outer/number")
Expand All@@ -64,23 +73,23 @@ public interface FakeApi {
 @ApiOperation(value = "", notes = "For this test, the body for this request much reference a schema named `File`.", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "Success", response = Void.class) })
 Response testBodyWithFileSchema(@Valid FileSchemaTestClass fileSchemaTestClass);
 Response testBodyWithFileSchema(@Valid FileSchemaTestClass body);

 @PUT
 @Path("/body-with-query-params")
 @Consumes({ "application/json" })
 @ApiOperation(value = "", notes = "", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "Success", response = Void.class) })
 Response testBodyWithQueryParams(@QueryParam("query") @NotNull String query,@Valid User user);
 Response testBodyWithQueryParams(@QueryParam("query") @NotNull String query,@Valid User body);
@wing328wing328Jan 3, 2020

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I noticed that the body parameter name changes from user to body. Likely you're not using the latest (or recent) master when creating this PR.
Please merge the latest master of the official repo into your branch and regenerate the sample again.
@shybovychashybovychaJan 3, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have used 4.3.x as the origin of my branch, are you sure I should merge master in?
@wing328wing328Jan 3, 2020

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK. Please put it on hold. I'll take another look over the weekend or next week.

 @PATCH
 @Consumes({ "application/json" })
 @Produces({ "application/json" })
 @ApiOperation(value = "To test \"client\" model", notes = "To test \"client\" model", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Client.class) })
 Response testClientModel(@Valid Client client);
 Response testClientModel(@Valid Client body);

 @POST
 @Consumes({ "application/x-www-form-urlencoded" })
Expand All@@ -98,15 +107,21 @@ public interface FakeApi {
 @ApiResponses(value = { 
 @ApiResponse(code = 400, message = "Invalid request", response = Void.class),
 @ApiResponse(code = 404, message = "Not found", response = Void.class) })
 Response testEnumParameters(@HeaderParam("enum_header_string_array") @DefaultValue("new ArrayList<String>()") @ApiParam("Header parameter enum test (string array)") List<String> enumHeaderStringArray,@HeaderParam("enum_header_string") @DefaultValue("-efg") @ApiParam("Header parameter enum test (string)") String enumHeaderString,@QueryParam("enum_query_string_array") @DefaultValue("new ArrayList<String>()") @ApiParam("Query parameter enum test (string array)") List<String> enumQueryStringArray,@QueryParam("enum_query_string") @DefaultValue("-efg") @ApiParam("Query parameter enum test (string)") String enumQueryString,@QueryParam("enum_query_integer") @ApiParam("Query parameter enum test (double)") Integer enumQueryInteger,@QueryParam("enum_query_double") @ApiParam("Query parameter enum test (double)") Double enumQueryDouble,@FormParam(value = "enum_form_string_array") List<String> enumFormStringArray,@FormParam(value = "enum_form_string") String enumFormString);
 Response testEnumParameters(@HeaderParam("enum_header_string_array") @DefaultValue("new ArrayList<String>()") @ApiParam("Header parameter enum test (string array)") List<String> enumHeaderStringArray,@HeaderParam("enum_header_string") @DefaultValue("-efg") @ApiParam("Header parameter enum test (string)") String enumHeaderString,@QueryParam("enum_query_string_array") @ApiParam("Query parameter enum test (string array)") List<String> enumQueryStringArray,@QueryParam("enum_query_string") @DefaultValue("-efg") @ApiParam("Query parameter enum test (string)") String enumQueryString,@QueryParam("enum_query_integer") @ApiParam("Query parameter enum test (double)") Integer enumQueryInteger,@QueryParam("enum_query_double") @ApiParam("Query parameter enum test (double)") Double enumQueryDouble,@FormParam(value = "enum_form_string_array") List<String> enumFormStringArray,@FormParam(value = "enum_form_string") String enumFormString);

 @DELETE
 @ApiOperation(value = "Fake endpoint to test group parameters (optional)", notes = "Fake endpoint to test group parameters (optional)", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 400, message = "Someting wrong", response = Void.class) })
 Response testGroupParameters(@QueryParam("required_string_group") @NotNull @ApiParam("Required String in group parameters") Integer requiredStringGroup,@HeaderParam("required_boolean_group") @NotNull @ApiParam("Required Boolean in group parameters") Boolean requiredBooleanGroup,@QueryParam("required_int64_group") @NotNull @ApiParam("Required Integer in group parameters") Long requiredInt64Group,@QueryParam("string_group") @ApiParam("String in group parameters") Integer stringGroup,@HeaderParam("boolean_group") @ApiParam("Boolean in group parameters") Boolean booleanGroup,@QueryParam("int64_group") @ApiParam("Integer in group parameters") Long int64Group);

 @POST
 @Path("/inline-additionalProperties")
 @Consumes({ "application/json" })
 @ApiOperation(value = "test inline additionalProperties", notes = "", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Void.class) })
 Response testInlineAdditionalProperties(@Valid Map<String, String> requestBody);
 Response testInlineAdditionalProperties(@Valid Map<String, String> param);

 @GET
 @Path("/jsonFormData")
Expand All@@ -116,6 +131,13 @@ public interface FakeApi {
 @ApiResponse(code = 200, message = "successful operation", response = Void.class) })
 Response testJsonFormData(@FormParam(value = "param") String param,@FormParam(value = "param2") String param2);

 @PUT
 @Path("/test-query-paramters")
 @ApiOperation(value = "", notes = "To test the collection format in query parameters", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "Success", response = Void.class) })
 Response testQueryParameterCollectionFormat(@QueryParam("pipe") @NotNull List<String> pipe,@QueryParam("ioutil") @NotNull List<String> ioutil,@QueryParam("http") @NotNull List<String> http,@QueryParam("url") @NotNull List<String> url,@QueryParam("context") @NotNull List<String> context);

 @POST
 @Path("/{petId}/uploadImageWithRequiredFile")
 @Consumes({ "multipart/form-data" })
Expand Down

2 changes: 1 addition & 1 deletion
...jaxrs-spec-interface-response/src/gen/java/org/openapitools/api/FakeClassnameTestApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,5 +25,5 @@ public interface FakeClassnameTestApi {
 }, tags={ "fake_classname_tags 123#$%^" })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Client.class) })
 Response testClassname(@Valid Client client);
 Response testClassname(@Valid Client body);
}

13 changes: 8 additions & 5 deletions
...rver/petstore/jaxrs-spec-interface-response/src/gen/java/org/openapitools/api/PetApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,8 +28,9 @@ public interface PetApi {
 })
 }, tags={ "pet", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Void.class),
 @ApiResponse(code = 405, message = "Invalid input", response = Void.class) })
 Response addPet(@Valid Pet pet);
 Response addPet(@Valid Pet body);

 @DELETE
 @Path("/{petId}")
Expand All@@ -40,8 +41,9 @@ public interface PetApi {
 })
 }, tags={ "pet", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Void.class),
 @ApiResponse(code = 400, message = "Invalid pet value", response = Void.class) })
 Response deletePet(@PathParam("petId") @ApiParam("Pet id to delete") Long petId,@HeaderParam("api_key") String apiKey);
 Response deletePet(@PathParam("petId") @ApiParam("Pet id to delete") Long petId,@HeaderParam("api_key") String apiKey);

 @GET
 @Path("/findByStatus")
Expand All@@ -55,7 +57,7 @@ public interface PetApi {
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Pet.class, responseContainer = "List"),
 @ApiResponse(code = 400, message = "Invalid status value", response = Void.class, responseContainer = "List") })
 Response findPetsByStatus(@QueryParam("status") @NotNull @DefaultValue("new ArrayList<String>()")  @ApiParam("Status values that need to be considered for filter") List<String> status);
 Response findPetsByStatus(@QueryParam("status") @NotNull @ApiParam("Status values that need to be considered for filter") List<String> status);

 @GET
 @Path("/findByTags")
Expand All@@ -69,7 +71,7 @@ public interface PetApi {
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Pet.class, responseContainer = "List"),
 @ApiResponse(code = 400, message = "Invalid tag value", response = Void.class, responseContainer = "List") })
 Response findPetsByTags(@QueryParam("tags") @NotNull @DefaultValue("new ArrayList<String>()")  @ApiParam("Tags to filter by") List<String> tags);
 Response findPetsByTags(@QueryParam("tags") @NotNull @ApiParam("Tags to filter by") List<String> tags);

 @GET
 @Path("/{petId}")
Expand All@@ -92,10 +94,11 @@ public interface PetApi {
 })
 }, tags={ "pet", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Void.class),
 @ApiResponse(code = 400, message = "Invalid ID supplied", response = Void.class),
 @ApiResponse(code = 404, message = "Pet not found", response = Void.class),
 @ApiResponse(code = 405, message = "Validation exception", response = Void.class) })
 Response updatePet(@Valid Pet pet);
 Response updatePet(@Valid Pet body);

 @POST
 @Path("/{petId}")
Expand Down

2 changes: 1 addition & 1 deletion
...er/petstore/jaxrs-spec-interface-response/src/gen/java/org/openapitools/api/StoreApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,5 +53,5 @@ public interface StoreApi {
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Order.class),
 @ApiResponse(code = 400, message = "Invalid Order", response = Void.class) })
 Response placeOrder(@Valid Order order);
 Response placeOrder(@Valid Order body);
}
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); }
})();
})();
[jaxrs-spec] Add builders to models by shybovycha · Pull Request #4916 · OpenAPITools/openapi-generator · GitHub
Skip to content
[jaxrs-spec] Add builders to models#4916

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

 Closed

shybovycha
wants to merge
5
commits into

from

 Closed


[jaxrs-spec] Add builders to models
#4916
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
a9add69

Update formatting in jaxrs-spec POJOs


shybovycha Jan 2, 2020
0ee1f21

Add generateBuilders option

Jan 2, 2020
3d620c8

Update formatting in jaxrs-spec POJOs


shybovycha Jan 2, 2020
e41bf0d

Generate samples

Jan 2, 2020
ccb071f

Disable the builders generation by default

Jan 5, 2020

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


11 changes: 10 additions & 1 deletion
...enerator/src/main/java/org/openapitools/codegen/languages/JavaJAXRSSpecServerCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ public class JavaJAXRSSpecServerCodegen extends AbstractJavaJAXRSServerCodegen {
 public static final String USE_SWAGGER_ANNOTATIONS = "useSwaggerAnnotations";
 public static final String JACKSON = "jackson";
 public static final String OPEN_API_SPEC_FILE_LOCATION = "openApiSpecFileLocation";
 public static final String GENERATE_BUILDERS = "generateBuilders";

 public static final String QUARKUS_LIBRARY = "quarkus";
 public static final String THORNTAIL_LIBRARY = "thorntail";
Expand All@@ -51,6 +52,7 @@ public class JavaJAXRSSpecServerCodegen extends AbstractJavaJAXRSServerCodegen {
 private boolean interfaceOnly = false;
 private boolean returnResponse = false;
 private boolean generatePom = true;
 private boolean generateBuilders = false;
 private boolean useSwaggerAnnotations = true;
 private boolean useJackson = false;
 private String openApiSpecFileLocation = "src/main/openapi/openapi.yaml";
Expand DownExpand Up@@ -102,6 +104,7 @@ public JavaJAXRSSpecServerCodegen() {

 cliOptions.add(library);
 cliOptions.add(CliOption.newBoolean(GENERATE_POM, "Whether to generate pom.xml if the file does not already exist.").defaultValue(String.valueOf(generatePom)));
 cliOptions.add(CliOption.newBoolean(GENERATE_BUILDERS, "Whether to generate builders for models.").defaultValue(String.valueOf(generateBuilders)));
 cliOptions.add(CliOption.newBoolean(INTERFACE_ONLY, "Whether to generate only API interface stubs without the server files.").defaultValue(String.valueOf(interfaceOnly)));
 cliOptions.add(CliOption.newBoolean(RETURN_RESPONSE, "Whether generate API interface should return javax.ws.rs.core.Response instead of a deserialized entity. Only useful if interfaceOnly is true.").defaultValue(String.valueOf(returnResponse)));
 cliOptions.add(CliOption.newBoolean(USE_SWAGGER_ANNOTATIONS, "Whether to generate Swagger annotations.", useSwaggerAnnotations));
Expand All@@ -125,14 +128,20 @@ public void processOpts() {
 additionalProperties.remove(RETURN_RESPONSE);
 }
 }
 if(QUARKUS_LIBRARY.equals(library) || THORNTAIL_LIBRARY.equals(library) || HELIDON_LIBRARY.equals(library) || OPEN_LIBERTY_LIBRARY.equals(library)) {
 if(QUARKUS_LIBRARY.equals(library) || THORNTAIL_LIBRARY.equals(library) || HELIDON_LIBRARY.equals(library) || OPEN_LIBERTY_LIBRARY.equals(library)) {
 useSwaggerAnnotations = false;
 } else {
 if (additionalProperties.containsKey(USE_SWAGGER_ANNOTATIONS)) {
 useSwaggerAnnotations = Boolean.valueOf(additionalProperties.get(USE_SWAGGER_ANNOTATIONS).toString());
 }
 }
 writePropertyBack(USE_SWAGGER_ANNOTATIONS, useSwaggerAnnotations);

 if (additionalProperties.containsKey(GENERATE_BUILDERS)) {
 generateBuilders = Boolean.valueOf(additionalProperties.get(GENERATE_BUILDERS).toString());
 }
 additionalProperties.put(GENERATE_BUILDERS, generateBuilders);

 if (additionalProperties.containsKey(OPEN_API_SPEC_FILE_LOCATION)) {
 openApiSpecFileLocation = additionalProperties.get(OPEN_API_SPEC_FILE_LOCATION).toString();
 } else if(QUARKUS_LIBRARY.equals(library) || THORNTAIL_LIBRARY.equals(library) || HELIDON_LIBRARY.equals(library)) {
Expand Down

71 changes: 45 additions & 26 deletions
modules/openapi-generator/src/main/resources/JavaJaxRS/spec/pojo.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,52 +1,38 @@
{{#useSwaggerAnnotations}}
import io.swagger.annotations.*;
{{/useSwaggerAnnotations}}
{{#useSwaggerAnnotations}}import io.swagger.annotations.*;{{/useSwaggerAnnotations}}
Comment thread
shybovycha marked this conversation as resolved.


Outdated

import java.util.Objects;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;

{{#discriminator}}{{>typeInfoAnnotation}}{{/discriminator}}{{#description}}
/**
{{#discriminator}}{{>typeInfoAnnotation}}{{/discriminator}}{{#description}}/**
 * {{description}}
 **/{{/description}}{{#useSwaggerAnnotations}}
{{#description}}{{>additionalModelTypeAnnotations}}@ApiModel(description = "{{{description}}}"){{/description}}{{/useSwaggerAnnotations}}
 **/{{/description}}
{{#useSwaggerAnnotations}}{{#description}}{{>additionalModelTypeAnnotations}}@ApiModel(description = "{{{description}}}"){{/description}}{{/useSwaggerAnnotations}}
public class {{classname}} {{#parent}}extends {{{parent}}}{{/parent}} {{#serializableModel}}implements Serializable{{/serializableModel}} {
 {{#vars}}{{#isEnum}}{{^isContainer}}

{{>enumClass}}{{/isContainer}}{{#isContainer}}{{#mostInnerItems}}

{{>enumClass}}{{/mostInnerItems}}{{/isContainer}}{{/isEnum}}
 private {{#useBeanValidation}}@Valid{{/useBeanValidation}}{{{datatypeWithEnum}}} {{name}}{{#defaultValue}} = {{{.}}}{{/defaultValue}};{{/vars}}
 private {{#useBeanValidation}}@Valid{{/useBeanValidation}}{{{datatypeWithEnum}}} {{name}}{{#defaultValue}} = {{{.}}}{{/defaultValue}};{{/vars}}

 {{#vars}}
 /**
 {{#description}}
 * {{description}}
 {{/description}}
 {{#minimum}}
 * minimum: {{minimum}}
 {{/minimum}}
 {{#maximum}}
 * maximum: {{maximum}}
 {{/maximum}}
 **/
 public {{classname}} {{name}}({{{datatypeWithEnum}}} {{name}}) {
 {{#generateBuilders}}public {{classname}}({{#vars}}{{{datatypeWithEnum}}} {{name}}{{#hasMore}}, {{/hasMore}}{{/vars}}) {
 {{#vars}}
 this.{{name}} = {{name}};
return this;
{{/vars}}
 }
 {{/generateBuilders}}

 {{#vendorExtensions.extraAnnotation}}{{{vendorExtensions.extraAnnotation}}}{{/vendorExtensions.extraAnnotation}}{{#useSwaggerAnnotations}}
 {{#vars}}{{#vendorExtensions.extraAnnotation}}{{{vendorExtensions.extraAnnotation}}}{{/vendorExtensions.extraAnnotation}}{{#useSwaggerAnnotations}}
 @ApiModelProperty({{#example}}example = "{{{example}}}", {{/example}}{{#required}}required = {{required}}, {{/required}}value = "{{{description}}}"){{/useSwaggerAnnotations}}
 @JsonProperty("{{baseName}}")
{{#useBeanValidation}}{{>beanValidation}}{{/useBeanValidation}} public {{{datatypeWithEnum}}} {{getter}}() {
 return {{name}};
 }

 public void {{setter}}({{{datatypeWithEnum}}} {{name}}) {
 this.{{name}} = {{name}};
 }

 {{/vars}}
 }{{/vars}}

 @Override
 public boolean equals(java.lang.Object o) {
Expand DownExpand Up@@ -88,4 +74,37 @@ public class {{classname}} {{#parent}}extends {{{parent}}}{{/parent}} {{#seriali
 }
 return o.toString().replace("\n", "\n ");
 }

 {{#generateBuilders}}
 public static Builder builder() {
 return new Builder();
 }

 public static class Builder {
 {{#vars}}
 private {{{datatypeWithEnum}}} {{name}}{{#defaultValue}} = {{{.}}}{{/defaultValue}};
 {{/vars}}

 {{#vars}}
 /**
 {{#description}}
 * {{description}}
 {{/description}}
 {{#minimum}}
 * minimum: {{minimum}}
 {{/minimum}}
 {{#maximum}}
 * maximum: {{maximum}}
 {{/maximum}}
 **/
 public Builder {{name}}({{{datatypeWithEnum}}} {{name}}) {
 this.{{name}} = {{name}};
 return this;
 }
 {{/vars}}

 public {{classname}} build() {
 return new {{classname}}({{#vars}}{{name}}{{#hasMore}}, {{/hasMore}}{{/vars}});
 }
 }{{/generateBuilders}}
}

2 changes: 1 addition & 1 deletion
samples/server/petstore/jaxrs-spec-interface-response/.openapi-generator/VERSION

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
3.3.0-SNAPSHOT
4.3.0-SNAPSHOT

2 changes: 1 addition & 1 deletion
...store/jaxrs-spec-interface-response/src/gen/java/org/openapitools/api/AnotherFakeApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,5 +24,5 @@ public interface AnotherFakeApi {
 @ApiOperation(value = "To test special tags", notes = "To test special tags and operation ID starting with number", tags={ "$another-fake?" })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Client.class) })
 Response call123testSpecialTags(@Valid Client client);
 Response call123testSpecialTags(@Valid Client body);
}

34 changes: 28 additions & 6 deletions
...ver/petstore/jaxrs-spec-interface-response/src/gen/java/org/openapitools/api/FakeApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@
import org.openapitools.model.ModelApiResponse;
import org.openapitools.model.OuterComposite;
import org.openapitools.model.User;
import org.openapitools.model.XmlItem;

import javax.ws.rs.*;
import javax.ws.rs.core.Response;
Expand All@@ -26,6 +27,14 @@
@Api(description = "the fake API")
public interface FakeApi {

 @POST
 @Path("/create_xml_item")
 @Consumes({ "application/xml", "application/xml; charset=utf-8", "application/xml; charset=utf-16", "text/xml", "text/xml; charset=utf-8", "text/xml; charset=utf-16" })
 @ApiOperation(value = "creates an XmlItem", notes = "this route creates an XmlItem", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Void.class) })
 Response createXmlItem(@Valid XmlItem xmlItem);

 @POST
 @Path("/outer/boolean")
 @Produces({ "*/*" })
Expand All@@ -40,7 +49,7 @@ public interface FakeApi {
 @ApiOperation(value = "", notes = "Test serialization of object with outer number type", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "Output composite", response = OuterComposite.class) })
 Response fakeOuterCompositeSerialize(@Valid OuterComposite outerComposite);
 Response fakeOuterCompositeSerialize(@Valid OuterComposite body);

 @POST
 @Path("/outer/number")
Expand All@@ -64,23 +73,23 @@ public interface FakeApi {
 @ApiOperation(value = "", notes = "For this test, the body for this request much reference a schema named `File`.", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "Success", response = Void.class) })
 Response testBodyWithFileSchema(@Valid FileSchemaTestClass fileSchemaTestClass);
 Response testBodyWithFileSchema(@Valid FileSchemaTestClass body);

 @PUT
 @Path("/body-with-query-params")
 @Consumes({ "application/json" })
 @ApiOperation(value = "", notes = "", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "Success", response = Void.class) })
 Response testBodyWithQueryParams(@QueryParam("query") @NotNull String query,@Valid User user);
 Response testBodyWithQueryParams(@QueryParam("query") @NotNull String query,@Valid User body);
@wing328wing328Jan 3, 2020

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I noticed that the body parameter name changes from user to body. Likely you're not using the latest (or recent) master when creating this PR.
Please merge the latest master of the official repo into your branch and regenerate the sample again.
@shybovychashybovychaJan 3, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have used 4.3.x as the origin of my branch, are you sure I should merge master in?
@wing328wing328Jan 3, 2020

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK. Please put it on hold. I'll take another look over the weekend or next week.

 @PATCH
 @Consumes({ "application/json" })
 @Produces({ "application/json" })
 @ApiOperation(value = "To test \"client\" model", notes = "To test \"client\" model", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Client.class) })
 Response testClientModel(@Valid Client client);
 Response testClientModel(@Valid Client body);

 @POST
 @Consumes({ "application/x-www-form-urlencoded" })
Expand All@@ -98,15 +107,21 @@ public interface FakeApi {
 @ApiResponses(value = { 
 @ApiResponse(code = 400, message = "Invalid request", response = Void.class),
 @ApiResponse(code = 404, message = "Not found", response = Void.class) })
 Response testEnumParameters(@HeaderParam("enum_header_string_array") @DefaultValue("new ArrayList<String>()") @ApiParam("Header parameter enum test (string array)") List<String> enumHeaderStringArray,@HeaderParam("enum_header_string") @DefaultValue("-efg") @ApiParam("Header parameter enum test (string)") String enumHeaderString,@QueryParam("enum_query_string_array") @DefaultValue("new ArrayList<String>()") @ApiParam("Query parameter enum test (string array)") List<String> enumQueryStringArray,@QueryParam("enum_query_string") @DefaultValue("-efg") @ApiParam("Query parameter enum test (string)") String enumQueryString,@QueryParam("enum_query_integer") @ApiParam("Query parameter enum test (double)") Integer enumQueryInteger,@QueryParam("enum_query_double") @ApiParam("Query parameter enum test (double)") Double enumQueryDouble,@FormParam(value = "enum_form_string_array") List<String> enumFormStringArray,@FormParam(value = "enum_form_string") String enumFormString);
 Response testEnumParameters(@HeaderParam("enum_header_string_array") @DefaultValue("new ArrayList<String>()") @ApiParam("Header parameter enum test (string array)") List<String> enumHeaderStringArray,@HeaderParam("enum_header_string") @DefaultValue("-efg") @ApiParam("Header parameter enum test (string)") String enumHeaderString,@QueryParam("enum_query_string_array") @ApiParam("Query parameter enum test (string array)") List<String> enumQueryStringArray,@QueryParam("enum_query_string") @DefaultValue("-efg") @ApiParam("Query parameter enum test (string)") String enumQueryString,@QueryParam("enum_query_integer") @ApiParam("Query parameter enum test (double)") Integer enumQueryInteger,@QueryParam("enum_query_double") @ApiParam("Query parameter enum test (double)") Double enumQueryDouble,@FormParam(value = "enum_form_string_array") List<String> enumFormStringArray,@FormParam(value = "enum_form_string") String enumFormString);

 @DELETE
 @ApiOperation(value = "Fake endpoint to test group parameters (optional)", notes = "Fake endpoint to test group parameters (optional)", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 400, message = "Someting wrong", response = Void.class) })
 Response testGroupParameters(@QueryParam("required_string_group") @NotNull @ApiParam("Required String in group parameters") Integer requiredStringGroup,@HeaderParam("required_boolean_group") @NotNull @ApiParam("Required Boolean in group parameters") Boolean requiredBooleanGroup,@QueryParam("required_int64_group") @NotNull @ApiParam("Required Integer in group parameters") Long requiredInt64Group,@QueryParam("string_group") @ApiParam("String in group parameters") Integer stringGroup,@HeaderParam("boolean_group") @ApiParam("Boolean in group parameters") Boolean booleanGroup,@QueryParam("int64_group") @ApiParam("Integer in group parameters") Long int64Group);

 @POST
 @Path("/inline-additionalProperties")
 @Consumes({ "application/json" })
 @ApiOperation(value = "test inline additionalProperties", notes = "", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Void.class) })
 Response testInlineAdditionalProperties(@Valid Map<String, String> requestBody);
 Response testInlineAdditionalProperties(@Valid Map<String, String> param);

 @GET
 @Path("/jsonFormData")
Expand All@@ -116,6 +131,13 @@ public interface FakeApi {
 @ApiResponse(code = 200, message = "successful operation", response = Void.class) })
 Response testJsonFormData(@FormParam(value = "param") String param,@FormParam(value = "param2") String param2);

 @PUT
 @Path("/test-query-paramters")
 @ApiOperation(value = "", notes = "To test the collection format in query parameters", tags={ "fake", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "Success", response = Void.class) })
 Response testQueryParameterCollectionFormat(@QueryParam("pipe") @NotNull List<String> pipe,@QueryParam("ioutil") @NotNull List<String> ioutil,@QueryParam("http") @NotNull List<String> http,@QueryParam("url") @NotNull List<String> url,@QueryParam("context") @NotNull List<String> context);

 @POST
 @Path("/{petId}/uploadImageWithRequiredFile")
 @Consumes({ "multipart/form-data" })
Expand Down

2 changes: 1 addition & 1 deletion
...jaxrs-spec-interface-response/src/gen/java/org/openapitools/api/FakeClassnameTestApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,5 +25,5 @@ public interface FakeClassnameTestApi {
 }, tags={ "fake_classname_tags 123#$%^" })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Client.class) })
 Response testClassname(@Valid Client client);
 Response testClassname(@Valid Client body);
}

13 changes: 8 additions & 5 deletions
...rver/petstore/jaxrs-spec-interface-response/src/gen/java/org/openapitools/api/PetApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,8 +28,9 @@ public interface PetApi {
 })
 }, tags={ "pet", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Void.class),
 @ApiResponse(code = 405, message = "Invalid input", response = Void.class) })
 Response addPet(@Valid Pet pet);
 Response addPet(@Valid Pet body);

 @DELETE
 @Path("/{petId}")
Expand All@@ -40,8 +41,9 @@ public interface PetApi {
 })
 }, tags={ "pet", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Void.class),
 @ApiResponse(code = 400, message = "Invalid pet value", response = Void.class) })
 Response deletePet(@PathParam("petId") @ApiParam("Pet id to delete") Long petId,@HeaderParam("api_key") String apiKey);
 Response deletePet(@PathParam("petId") @ApiParam("Pet id to delete") Long petId,@HeaderParam("api_key") String apiKey);

 @GET
 @Path("/findByStatus")
Expand All@@ -55,7 +57,7 @@ public interface PetApi {
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Pet.class, responseContainer = "List"),
 @ApiResponse(code = 400, message = "Invalid status value", response = Void.class, responseContainer = "List") })
 Response findPetsByStatus(@QueryParam("status") @NotNull @DefaultValue("new ArrayList<String>()")  @ApiParam("Status values that need to be considered for filter") List<String> status);
 Response findPetsByStatus(@QueryParam("status") @NotNull @ApiParam("Status values that need to be considered for filter") List<String> status);

 @GET
 @Path("/findByTags")
Expand All@@ -69,7 +71,7 @@ public interface PetApi {
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Pet.class, responseContainer = "List"),
 @ApiResponse(code = 400, message = "Invalid tag value", response = Void.class, responseContainer = "List") })
 Response findPetsByTags(@QueryParam("tags") @NotNull @DefaultValue("new ArrayList<String>()")  @ApiParam("Tags to filter by") List<String> tags);
 Response findPetsByTags(@QueryParam("tags") @NotNull @ApiParam("Tags to filter by") List<String> tags);

 @GET
 @Path("/{petId}")
Expand All@@ -92,10 +94,11 @@ public interface PetApi {
 })
 }, tags={ "pet", })
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Void.class),
 @ApiResponse(code = 400, message = "Invalid ID supplied", response = Void.class),
 @ApiResponse(code = 404, message = "Pet not found", response = Void.class),
 @ApiResponse(code = 405, message = "Validation exception", response = Void.class) })
 Response updatePet(@Valid Pet pet);
 Response updatePet(@Valid Pet body);

 @POST
 @Path("/{petId}")
Expand Down

2 changes: 1 addition & 1 deletion
...er/petstore/jaxrs-spec-interface-response/src/gen/java/org/openapitools/api/StoreApi.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,5 +53,5 @@ public interface StoreApi {
 @ApiResponses(value = { 
 @ApiResponse(code = 200, message = "successful operation", response = Order.class),
 @ApiResponse(code = 400, message = "Invalid Order", response = Void.class) })
 Response placeOrder(@Valid Order order);
 Response placeOrder(@Valid Order body);
}
Loading