Skip to content
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.

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

[jaxrs-spec] add Eclipse MicroProfile file based approach #3901

Merged
merged 12 commits into from
Oct 1, 2019

Conversation

jmini
Copy link
Member

@jmini jmini commented Sep 17, 2019

When using Eclipse-MicroProfile-OpenAPI framework, a small specification on top of JaxRS, you have two ways of enhancing your OpenAPI document.

  1. with annotations (approach similar to swagger-jaxrs2)
  2. with an OpenAPI document, placed at a predetermined location.

In order to use MicroProfile, you need to select the implementation you would like to use (similar to JavaEE/Jakarta EE, several vendors implement the same spec).


This PR is adding some support for the second variant (OpenAPI file based) approach.

The library flag is used to select the desired implementation:

  • Helidon
  • Open-Liberty
  • Quarkus
  • Thorntail

@wing328
Copy link
Member

wing328 commented Sep 17, 2019

Reported by CircleCI:

--- a/docs/generators/jaxrs-spec.md
+++ b/docs/generators/jaxrs-spec.md
@@ -46,7 +46,7 @@ sidebar_label: jaxrs-spec
 |title|a title describing the application| |OpenAPI Server|
 |useBeanValidation|Use BeanValidation API annotations| |true|
 |serverPort|The port on which the server should be started| |8080|
-|library|library template (sub-template)|<dl><dt>**&lt;default&gt;**</dt><dd>JAXRS</dd><dl>|&lt;default&gt;|
+|library|library template (sub-template)|<dl><dt>**&lt;default&gt;**</dt><dd>JAXRS spec only, to be deployed in an app server (TomEE, JBoss, WLS, ...)</dd><dt>**quarkus**</dt><dd>Server using Quarkus</dd><dt>**thorntail**</dt><dd>Server using Thorntail</dd><dt>**openliberty**</dt><dd>Server using Open Liberty</dd><dt>**helidon**</dt><dd>Server using Helidon</dd><dl>|&lt;default&gt;|
 |generatePom|Whether to generate pom.xml if the file does not already exist.| |true|
 |interfaceOnly|Whether to generate only API interface stubs without the server files.| |false|
 |returnResponse|Whether generate API interface should return javax.ws.rs.core.Response instead of a deserialized entity. Only useful if interfaceOnly is true.| |false|
Perform git status
On branch pull/3901
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git checkout -- <file>..." to discard changes in working directory)

	modified:   docs/generators/jaxrs-cxf-cdi.md
	modified:   docs/generators/jaxrs-spec.md

no changes added to commit (use "git add" and/or "git commit -a")
Please run 'bin/utils/ensure-up-to-date' locally and commit changes (UNCOMMITTED CHANGES ERROR)

Please run the following to update the doc as well

"./bin/utils/export_docs_generators.sh"
"./bin/utils/copy-to-website.sh"
"./bin/utils/export_generators_readme.sh"

@wing328 wing328 added this to the 4.1.3 milestone Sep 17, 2019
@wing328
Copy link
Member

wing328 commented Sep 21, 2019

Tested with --library openliberty and got the following errors:

[ERROR]   symbol:   class ApiParam
[ERROR]   location: class org.openapitools.api.PetApi
[ERROR] /private/tmp/jaxrs-spec4/src/gen/java/org/openapitools/api/PetApi.java:[72,6] cannot find symbol
[ERROR]   symbol:   class ApiOperation
[ERROR]   location: class org.openapitools.api.PetApi
[ERROR] /private/tmp/jaxrs-spec4/src/gen/java/org/openapitools/api/PetApi.java:[77,6] cannot find symbol
[ERROR]   symbol:   class ApiResponses
[ERROR]   location: class org.openapitools.api.PetApi
[ERROR] /private/tmp/jaxrs-spec4/src/gen/java/org/openapitools/api/PetApi.java:[96,53] cannot find symbol
[ERROR]   symbol:   class ApiParam
[ERROR]   location: class org.openapitools.api.PetApi
[ERROR] -> [Help 1]
[ERROR] 
[ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR] 
[ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoFailureException

and got the same result with Quarkus, Thorntail

Seems like only --library helidon and the default (without the library option) compile without errors.

e.g. java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -g jaxrs-spec -o /tmp/jaxrs-spec3/ --library helidon

@jmini
Copy link
Member Author

jmini commented Oct 1, 2019

Thank you for having tried this. I could reproduce the issue.


During my tests, I was always testing with useSwaggerAnnotations = false (see #813 and the discussion around this).

The Eclipse-MicroProfile-OpenAPI implementation will never support swagger-annotations, so I added a comment to enforce that useSwaggerAnnotations is set to false if one of those app server is used.

@wing328
Copy link
Member

wing328 commented Oct 1, 2019

Looks good now 👍

@wing328 wing328 merged commit d2b2998 into OpenAPITools:master Oct 1, 2019
Jesse0Michael pushed a commit to Jesse0Michael/openapi-generator that referenced this pull request Oct 3, 2019
…ls#3901)

* [jaxrs-spec] add quarkus application server

* [jaxrs-spec] add thorntail

* [jaxrs-spec] add openliberty

* [quarkus] update to 0.20.0

* Add helidon

* Update quarkus version

* Update quarkus to 0.22.0

* Update documentation

* Force "useSwaggerAnnotations" to be false when quarkus, thorntail,
openliberty or helidon are used
jmini added a commit to jmini/openapi-experiments that referenced this pull request Oct 4, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants