Add new generator: Java Play Framework Server Generator #4943

JFCote · 2017-03-06T15:40:23Z

First commit of the Java Play Framework server generator. It is highly based on Spring so there might me a couple of things that don't make sense (like options or parameters) for the Play Framework.

First time ever contributing to a GitHub project. Bare with me! If anything is wrong, let me know!

There is an existing issue asking for this framework here: #3057

I only support Java and currently have no time/interest in supporting Scala.

This was developed at the company I work for: Stingray. www.stingray.com

PR checklist

Read the contribution guildelines.
Ran the shell/batch script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh and ./bin/security/{LANG}-petstore.sh if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates)
Filed the PR against the correct branch: master for non-breaking changes and 2.3.0 branch for breaking (non-backward compatible) changes.

Description of the PR

This is a working version of the Java Play Framework Server swagger-codegen. It will support most of the swagger specs except having arrays in some places because of a bug in the swagger-play (no support for this in the ImplicitParam). I have commented on this in the code itself and created the bugs in the swagger-play project but no one seems to be taking care of it ;)

Anyway, since it's my first time contributing on GitHub, I may have done n00b things, so just let me know and I'll provide fixes a soon as possible.

This has been run and tested using the Maven command "clean package" and everything runs, so it should be ok.

Thanks!

…y based on Spring so there might me a couple of things that don't make sense (like options or parameters) for the Play Framework.

wing328 · 2017-03-06T15:54:23Z

...les/swagger-codegen/src/main/java/io/swagger/codegen/languages/JavaPlayFrameworkCodegen.java

+
+        //TODO: Validate this?
+        // play framework uses the jackson lib, why have a parameter for this?
+        additionalProperties.put("jackson", "true");


Putting something in the additionalProperties will allow you to use it in the mustache templates. For this case, one can do the following:

{{#jackson}} // do something for jackson here {{/jackson}}

Will keep it there so it use jackson by default. Will remove the TODO

wing328 · 2017-03-06T15:55:30Z

...les/swagger-codegen/src/main/java/io/swagger/codegen/languages/JavaPlayFrameworkCodegen.java

+
+    @Override
+    public String getName() {
+        return "javaPlayFramework";


I would suggest lower case with "-", e.g. java-play-framework
which is the convention used by other generators.

Done in my next commit! Thanks

wing328 · 2017-03-06T15:56:44Z

modules/swagger-codegen/src/main/resources/JavaPlayFramework/LICENSE.mustache

@@ -0,0 +1,8 @@
+This software is licensed under the Apache 2 license, quoted below.


We might later need to empty this file as there's a discussion about not setting any license to the auto-generated code and let the users to decide which license (e.g. MIT, GNU, Apache2, etc) to use.

no problem. I was just mimicking the output of a brand new Play Framework project.

wing328 · 2017-03-06T16:00:19Z

@JFCote thanks for the contribution 👏 👏 👏

I left you some comments.

I would also suggest you to add a shell script (example) or batch file (example) to generate Petstore sample for this new generator. (or I can do it later for you after this PR is merged)

wing328 · 2017-03-06T16:02:54Z

Btw, for your upcoming PRs (not this PR), I would suggest creating a new branch as per git best-practice.

JFCote · 2017-03-06T16:07:02Z

Just to be sure:
@wing328 : When you say to create a new branch, do you want me to create a branch in my forked repo and then submit this branch as a PR for my next PR?

wing328 · 2017-03-06T16:15:00Z

@JFCote yup, currently you're making changes in your master.

I usually create a new branch (e.g. git checkout -b 'fix_issue_9999') for the change.

JFCote · 2017-03-06T16:18:21Z

@wing328 : Ok no problem I will do that on my next commits.

…sted.

ePaul

Hi, thanks for your pull request. I noted one issue which I just fixed everywhere from where you copied, so it would be nice if you fixed this before merging.

Please use {{baseName}} instead of {{paramName}} in annotations which refer to the on-the-wire parameter name.
{{paramName}} is the sanitized version of the parameter name, {{baseName}} how it was mentioned in the API definition. (See #4898 for a lot of cleanup regarding this.)

I noted all points where I found this.

(Though I don't know anything about how Play works, so it could be that in some of those places actually the sanitized name is better. If so, please tell me.)

ePaul · 2017-03-06T19:44:01Z

modules/swagger-codegen/src/main/resources/JavaPlayFramework/formParams.mustache

@@ -0,0 +1 @@
+{{#isFormParam}}{{#notFile}}@ApiParam(value = "{{{description}}}"{{#required}}, required=true{{/required}} {{#allowableValues}}, allowableValues="{{#enumVars}}{{{name}}}{{^-last}}, {{/-last}}{{#-last}}{{/-last}}{{/enumVars}}"{{/allowableValues}}{{#defaultValue}}, defaultValue="{{{defaultValue}}}"{{/defaultValue}}) @RequestPart(value="{{paramName}}"{{#required}}, required=true{{/required}}{{^required}}, required=false{{/required}})  {{{dataType}}} {{paramName}}{{/notFile}}{{#isFile}}@ApiParam(value = "file detail") @RequestPart("file") MultipartFile {{baseName}}{{/isFile}}{{/isFormParam}}


Please use {{baseName}} instead of {{paramName}} in annotations which refer to the on-the-wire parameter name.
{{paramName}} is the sanitized version of the parameter name, {{baseName}} how it was mentioned in the API definition. (See #4898 for a lot of cleanup regarding this.)

This file has been deleted because it is not used (copy pasted from swing)

ePaul · 2017-03-06T19:45:43Z