[Spring]Added support for composed annotations (@GetMapping,@PostMapping,@PutMapping,@DeleteMapping). #21118
Conversation
There was a problem hiding this comment.
Hi @dRbAndrade, thanks for the PR!
Could you please take care of the review comments below and also add your new lambda to this section in the docs:
openapi-generator/docs/templating.md
Line 817 in 4cffd32
| @@ -226,8 +226,15 @@ public interface {{classname}} { | |||
| }) | |||
| {{/swagger1AnnotationLibrary}} | |||
| {{/implicitHeadersParams.0}} | |||
| {{#useApiComposedAnnotation}} | |||
| {{#lambda.composedannotationlambda}}{{httpMethod}}{{/lambda.composedannotationlambda}} | |||
There was a problem hiding this comment.
Please rename it to lambda.composedannotation.
There was a problem hiding this comment.
PS: This should also include updating the JavaDoc in ComposedRequestMappingAnnotationLambda.java.
| @@ -98,6 +98,8 @@ public class SpringCodegen extends AbstractJavaCodegen | |||
| public static final String USE_SEALED = "useSealed"; | |||
| public static final String OPTIONAL_ACCEPT_NULLABLE = "optionalAcceptNullable"; | |||
| public static final String USE_SPRING_BUILT_IN_VALIDATION = "useSpringBuiltInValidation"; | |||
| public static final String USE_API_COMPOSED_ANNOTATION = "useApiComposedAnnotation"; | |||
| public static final String API_COMPOSED_ANNOTATION_LAMBDA = "apiComposedAnnotationLambda"; | |||
There was a problem hiding this comment.
This is not used anywhere, please remove it.
| @@ -224,6 +228,9 @@ public SpringCodegen() { | |||
| cliOptions.add(CliOption.newBoolean(USE_SPRING_BUILT_IN_VALIDATION, | |||
| "Disable `@Validated` at the class level when using built-in validation.", | |||
| useSpringBuiltInValidation)); | |||
| cliOptions.add(CliOption.newBoolean(USE_API_COMPOSED_ANNOTATION, | |||
| "Use @<method>Mapping instead of @RequestMapping(method = RequestMethod.<method>) when generating the API interfaces.", | |||
| useApiComposedAnnotation)); | |||
There was a problem hiding this comment.
We could even make it true by default. What do you think? @dRbAndrade @wing328
| @Override | ||
| public void execute(Template.Fragment fragment, Writer writer) throws IOException { | ||
| String text = fragment.execute(); | ||
| writer.write(String.format("@%sMapping(",text.substring(0,1).toUpperCase()+text.substring(1).toLowerCase())); |
There was a problem hiding this comment.
This fails if the input String is empty. Would be nice if this case could be handled gracefully.
| {{/useApiComposedAnnotation}} | ||
| {{^useApiComposedAnnotation}} |
There was a problem hiding this comment.
It looks like you can remove these 2 lines.
I have noticed that when using the Spring generator, the API interface file would contain @RequestMapping(method = RequestMethod.) annotation. This would isn't exactly an issue but would be a code smell under sonar coding rule java:s4488 https://sonarsource.github.io/rspec/#/rspec/S4488. I tried to search for an existing way to change it but could not find it. So I went ahead and added the support myself.
This is a change for Java Spring generator so I'm tagging the committee:
@cachescrubber @welshm @MelleD @atextor @manedev79 @javisst @borsch @banlevente @Zomzog @martin-mfg
PR checklist
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*.IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
master(upcoming7.x.0minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks)