Skip to content

Implement Server Stub Code for Vert.x Web #4286

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

Jump to bottom
Merged
merged 22 commits into from
Oct 28, 2019
Merged

Implement Server Stub Code for Vert.x Web #4286

merged 22 commits into from
Oct 28, 2019

Conversation

lwlee2608
Copy link
Contributor

@lwlee2608 lwlee2608 commented Oct 26, 2019 •
edited by wing328
Loading

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.1.x, 5.0.x. Default: master.
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

Description of the PR

Add server generation java-vertx-web which use Vert.x-Web

cc @wing328 @jimschubert @cbornet @ackintosh @jmini @etherealjoy

For #115

lwlee2608 added 17 commits July 19, 2019 16:45
@lwlee2608
InlineResolver to flatten callback operations
4bfd819 
Signed-off-by: lwlee2608 <[email protected]>
@lwlee2608
Merge remote-tracking branch 'origin/master'
cf9c013
@lwlee2608
Merge remote-tracking branch 'upstream/master'
2dac28a
@lwlee2608
clone from VertxServerCodegen, to new VertxWebServerCodegen
30e5619
@lwlee2608
Merge remote-tracking branch 'upstream/master'
d429663
@lwlee2608
fix compilation error in VertxWebCodegn
cf25454
@lwlee2608
Start working on VertxWebServerCodegen, adding support files
8ab01a4
@lwlee2608
add server api handler
4c76f6f
@lwlee2608
add server api and fix yaml spec file generation
748d33e
@lwlee2608
link api to apiHandler
3ce43b9
@lwlee2608
convert vertx parameters into API model
28a611a
@lwlee2608
add support to multipart/form-data upload files
8e6f751
@lwlee2608
ability to set http status code from ApiImpl
85fded7
@lwlee2608
replace rootPackage with invokerPackage
1e23f3c
@lwlee2608
add readme and sample
e3046b4
@lwlee2608
Merge remote-tracking branch 'upstream/master'
2beadb1
@lwlee2608
fix circleCi error
99c6d9c
wing328
wing328 reviewed Oct 27, 2019
View reviewed changes
bin/java-vertx-web-rx-petstore-server.sh Outdated

# if you've executed sbt assembly previously it will use that instead.
export JAVA_OPTS="${JAVA_OPTS} -Xmx1024M -DloggerPath=conf/log4j.properties"
ags="generate -i $SPEC -g $GENERATOR --artifact-id java-vertx-web-rx-server -o $STUB_DIR --additional-properties hideGenerationTimestamp=true $@"
Copy link
Member

Choose a reason for hiding this comment

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

Minor suggestion: adding -t with the resource (template) folder so that we don't need to recompile the whole project if we're only changing the templates.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

i see, good idea.

wing328
wing328 reviewed Oct 27, 2019
View reviewed changes
...pi-generator/src/main/java/org/openapitools/codegen/languages/JavaVertXWebServerCodegen.java Outdated
@@ -0,0 +1,162 @@
/*
* Copyright 2018 OpenAPI-Generator Contributors (https://openapi-generator.tech)
* Copyright 2018 SmartBear Software
Copy link
Member

Choose a reason for hiding this comment

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

@lwlee2608 I don't think we need line 3 as per https://opensource.stackexchange.com/questions/7300/copyright-notice-in-the-file-header-apache-v2-license/7301#7301

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ok, done

wing328
wing328 reviewed Oct 27, 2019
View reviewed changes
modules/openapi-generator/src/main/resources/JavaVertXWebServer/README.mustache Outdated

To build the project using maven, run:
```bash
mvn package && java -jar target/target/java-vertx-web-rx-server-1.0.0-SNAPSHOT-fat.jar
Copy link
Member

Choose a reason for hiding this comment

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

Do we need to use {{artifactVersion}} instead of hard-coded 1.0.0-SNAPSHOT?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

my mistake, done

@wing328
Copy link
Member

wing328 commented Oct 27, 2019

Tested locally and the result is good:

[INFO] skip non existing resourceDirectory /private/tmp/vertx2/src/test/resources
[INFO] 
[INFO] --- maven-compiler-plugin:3.3:testCompile (default-testCompile) @ openapi-java-vertx-web-server ---
[INFO] No sources to compile
[INFO] 
[INFO] --- maven-surefire-plugin:2.12.4:test (default-test) @ openapi-java-vertx-web-server ---
[INFO] No tests to run.
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 1.732 s
[INFO] Finished at: 2019-10-27T12:29:13+08:00
[INFO] ------------------------------------------------------------------------

@wing328
Copy link
Member

wing328 commented Oct 27, 2019

Please add a new entry for testing in https://github.com/OpenAPITools/openapi-generator/blob/master/pom.xml#L1166

If the output works with JDK7 as well, please also add an entry to https://github.com/OpenAPITools/openapi-generator/blob/master/pom.xml#L1205

@wing328 wing328 added this to the 4.2.0 milestone Oct 27, 2019
@lwlee2608
Copy link
Contributor Author

@wing328 all comments have been addressed. Please review

The server uses Java8 feature extensively, therefore does not work in JDK7 or lower.

wing328
wing328 approved these changes Oct 28, 2019
View reviewed changes
Copy link
Member

@wing328 wing328 left a comment

Choose a reason for hiding this comment

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

LGTM. Let's merge it into master and get some feedback from the community.

@wing328 wing328 merged commit 0f2272d into OpenAPITools:master Oct 28, 2019
@wing328
Copy link
Member

wing328 commented Oct 28, 2019

@lwlee2608 thanks for the new generator, which has been merged into master.

For your upcoming PRs, I would recommend creating a new branch as per git best practice.

@wing328 wing328 mentioned this pull request Oct 28, 2019
Merged
@wing328 wing328 changed the title Implement Server Stub Code for Vert.x Web #115 Implement Server Stub Code for Vert.x Web Oct 31, 2019
@wing328
Copy link
Member

wing328 commented Oct 31, 2019 •
edited
Loading

@lwlee2608 thanks for the PR, which has been included in v4.2.0 release: https://twitter.com/oas_generator/status/1189824932345069569

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@wing328 wing328 wing328 approved these changes

Assignees
No one assigned
Labels
Enhancement: New generator Server: Java
Projects
None yet
Milestone
4.2.0
Development

Successfully merging this pull request may close these issues.
2 participants
@lwlee2608 @wing328