Skip to content

[Java] springmvc lombok models#5430

Closed
com2ghz wants to merge 21 commits intoOpenAPITools:masterfrom
com2ghz:java_springmvc_lombok_models
Closed

[Java] springmvc lombok models#5430
com2ghz wants to merge 21 commits intoOpenAPITools:masterfrom
com2ghz:java_springmvc_lombok_models

Conversation

@com2ghz
Copy link

@com2ghz com2ghz commented Feb 25, 2020

For spring-mvc you can enable lombok for your models. This encourages the use of immutable objects that comes with a builder.
When lombok is enabled, there are no setters anymore.
Using a builder is very convenient for unit testing.
So the following annotations are added to your model:

@AllArgsConstructor //On the class, when there is at least one property
@EqualsAndHashCode ///On the class, When there is at least one property
@ToString //On the class, when there is at least one property
@Getter //On the class, when there is at least one property
@SuperBuilder //On the class, when the model has a parent
@Builder //On the class, when there is no parent
@NonNull //On the field, when the property is required.

Currently only available for language: spring and library spring-mvc with additional-properties isLombokModel

Example:
generate -i swagger.yaml -g spring --library spring-mvc --additional-properties isLombokModel -o src/1111

PR checklist

  • Read the contribution guidelines.
  • If contributing template-only or documentation-only changes which will change sample output, build the project before.
  • Run the shell script(s) under ./bin/ (or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
  • File the PR against the correct branch: master, 4.3.x, 5.0.x. Default: master.
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

@gavin-haynes-grow
Copy link

Imports are still not generated for me. I just hot fixed it with

diff --git a/modules/openapi-generator/src/main/resources/JavaSpring/model.mustache b/modules/openapi-generator/src/main/resources/JavaSpring/model.mustache
index fbe3a9f1..8054318b 100644
--- a/modules/openapi-generator/src/main/resources/JavaSpring/model.mustache
+++ b/modules/openapi-generator/src/main/resources/JavaSpring/model.mustache
@@ -28,6 +28,9 @@ import javax.xml.bind.annotation.*;
 import org.springframework.hateoas.RepresentationModel;
 {{/hateoas}}
 {{/parent}}
+{{#isLombokModel}}
+import lombok.*;
+{{/isLombokModel}}
 
 {{#models}}
 {{#model}}

@gerardbosch
Copy link

gerardbosch commented Nov 10, 2022

Is this PR still relevant? I realized it was approved on 2020... Despite not using myself OpenAPI generator right now, it would be very, very, nice to have Lombok in Java models =)

@com2ghz
Copy link
Author

com2ghz commented Nov 10, 2022

Is this PR still relevant? I realized it was approved on 2020... Despite not using myself OpenAPI generator right now, it would be very, very, nice to have Lombok in Java models =)

No, I will close this PR. You can do lombok using the annotations and creating the templates. I might make a PR for that in the future

@com2ghz com2ghz closed this Nov 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

Comments