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

Merged
wing328 merged 12 commits into
OpenAPITools:masterfrom
jmini:add-app-servers
Oct 1, 2019
Merged

[jaxrs-spec] add Eclipse MicroProfile file based approach#3901
wing328 merged 12 commits into
OpenAPITools:masterfrom
jmini:add-app-servers

Conversation

@jmini

@jminijmini commented Sep 17, 2019

Copy link
Copy Markdown
Member

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

This was referenced Sep 17, 2019
Closed
Open
@wing328

wing328 commented Sep 17, 2019

Copy link
Copy Markdown
Member

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"

@wing328wing328 added this to the 4.1.3 milestone Sep 17, 2019
@wing328

wing328 commented Sep 21, 2019•
edited
Loading

Copy link
Copy Markdown
Member

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

jmini commented Oct 1, 2019

Copy link
Copy Markdown
MemberAuthor

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

wing328 commented Oct 1, 2019

Copy link
Copy Markdown
Member

Looks good now 👍

@wing328
wing328 merged commit d2b2998 into OpenAPITools:masterOct 1, 2019
Jesse0Michael pushed a commit to Jesse0Michael/openapi-generator that referenced this pull request Oct 3, 2019
@jminiJesse Michael
[jaxrs-spec] add Eclipse MicroProfile file based approach (OpenAPIToo…
a1555fd
…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
@jmini
Add petstore projects for helidon, openliberty, quarkus and thorntail
5d8c8c2
Introduced with PR OpenAPITools/openapi-generator#3901
@jminijmini mentioned this pull request Oct 4, 2019
Merged
4 tasks
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

Enhancement: FeatureServer: Java

Projects

None yet

Milestone

4.1.3

Development

Successfully merging this pull request may close these issues.

2 participants

@jmini@wing328
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
[jaxrs-spec] add Eclipse MicroProfile file based approach - #3901
Merged
wing328 merged 12 commits into
OpenAPITools:masterfrom 
jmini:add-app-servers
Oct 1, 2019
Merged
[jaxrs-spec] add Eclipse MicroProfile file based approach#3901
wing328 merged 12 commits into
OpenAPITools:masterfrom 
jmini:add-app-servers
Conversation
@jmini
@jminijmini
commented
Sep 17, 2019

Copy link


Copy Markdown

Member
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

This was referenced Sep 17, 2019

Closed


Open

@wing328
wing328
commented
Sep 17, 2019

Copy link


Copy Markdown

Member
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"

@wing328wing328
added this to the 4.1.3 milestone
Sep 17, 2019
@wing328
wing328
commented
Sep 21, 2019•

edited

Loading

Copy link


Copy Markdown

Member
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
jmini
commented
Oct 1, 2019

Copy link


Copy Markdown

MemberAuthor
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
wing328
commented
Oct 1, 2019

Copy link


Copy Markdown

Member
Looks good now 👍
@wing328
wing328
merged commit d2b2998
into
OpenAPITools:masterOct 1, 2019
Jesse0Michael pushed a commit
to Jesse0Michael/openapi-generator
that referenced
this pull request
Oct 3, 2019
@jminiJesse Michael
[jaxrs-spec] add Eclipse MicroProfile file based approach (OpenAPIToo…
a1555fd
…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
@jmini
Add petstore projects for helidon, openliberty, quarkus and thorntail
5d8c8c2
Introduced with PR OpenAPITools/openapi-generator#3901
@jminijmini
mentioned this pull request
Oct 4, 2019
 Merged

4 tasks
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


No reviews


Assignees


No one assigned


Labels

Enhancement: FeatureServer: Java

Projects


None yet


Milestone

4.1.3

Development

Successfully merging this pull request may close these issues.

2 participants

@jmini@wing328

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
[jaxrs-spec] add Eclipse MicroProfile file based approach - #3901
Merged
wing328 merged 12 commits into
OpenAPITools:masterfrom 
jmini:add-app-servers
Oct 1, 2019
Merged
[jaxrs-spec] add Eclipse MicroProfile file based approach#3901
wing328 merged 12 commits into
OpenAPITools:masterfrom 
jmini:add-app-servers
Conversation
@jmini
@jminijmini
commented
Sep 17, 2019

Copy link


Copy Markdown

Member
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

This was referenced Sep 17, 2019

Closed


Open

@wing328
wing328
commented
Sep 17, 2019

Copy link


Copy Markdown

Member
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"

@wing328wing328
added this to the 4.1.3 milestone
Sep 17, 2019
@wing328
wing328
commented
Sep 21, 2019•

edited

Loading

Copy link


Copy Markdown

Member
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
jmini
commented
Oct 1, 2019

Copy link


Copy Markdown

MemberAuthor
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
wing328
commented
Oct 1, 2019

Copy link


Copy Markdown

Member
Looks good now 👍
@wing328
wing328
merged commit d2b2998
into
OpenAPITools:masterOct 1, 2019
Jesse0Michael pushed a commit
to Jesse0Michael/openapi-generator
that referenced
this pull request
Oct 3, 2019
@jminiJesse Michael
[jaxrs-spec] add Eclipse MicroProfile file based approach (OpenAPIToo…
a1555fd
…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
@jmini
Add petstore projects for helidon, openliberty, quarkus and thorntail
5d8c8c2
Introduced with PR OpenAPITools/openapi-generator#3901
@jminijmini
mentioned this pull request
Oct 4, 2019
 Merged

4 tasks
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


No reviews


Assignees


No one assigned


Labels

Enhancement: FeatureServer: Java

Projects


None yet


Milestone

4.1.3

Development

Successfully merging this pull request may close these issues.

2 participants

@jmini@wing328

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
[jaxrs-spec] add Eclipse MicroProfile file based approach - #3901
Merged
wing328 merged 12 commits into
OpenAPITools:masterfrom 
jmini:add-app-servers
Oct 1, 2019
Merged
[jaxrs-spec] add Eclipse MicroProfile file based approach#3901
wing328 merged 12 commits into
OpenAPITools:masterfrom 
jmini:add-app-servers
Conversation
@jmini
@jminijmini
commented
Sep 17, 2019

Copy link


Copy Markdown

Member
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

This was referenced Sep 17, 2019

Closed


Open

@wing328
wing328
commented
Sep 17, 2019

Copy link


Copy Markdown

Member
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"

@wing328wing328
added this to the 4.1.3 milestone
Sep 17, 2019
@wing328
wing328
commented
Sep 21, 2019•

edited

Loading

Copy link


Copy Markdown

Member
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
jmini
commented
Oct 1, 2019

Copy link


Copy Markdown

MemberAuthor
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
wing328
commented
Oct 1, 2019

Copy link


Copy Markdown

Member
Looks good now 👍
@wing328
wing328
merged commit d2b2998
into
OpenAPITools:masterOct 1, 2019
Jesse0Michael pushed a commit
to Jesse0Michael/openapi-generator
that referenced
this pull request
Oct 3, 2019
@jminiJesse Michael
[jaxrs-spec] add Eclipse MicroProfile file based approach (OpenAPIToo…
a1555fd
…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
@jmini
Add petstore projects for helidon, openliberty, quarkus and thorntail
5d8c8c2
Introduced with PR OpenAPITools/openapi-generator#3901
@jminijmini
mentioned this pull request
Oct 4, 2019
 Merged

4 tasks
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


No reviews


Assignees


No one assigned


Labels

Enhancement: FeatureServer: Java

Projects


None yet


Milestone

4.1.3

Development

Successfully merging this pull request may close these issues.

2 participants

@jmini@wing328

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
[jaxrs-spec] add Eclipse MicroProfile file based approach - #3901
Merged
wing328 merged 12 commits into
OpenAPITools:masterfrom 
jmini:add-app-servers
Oct 1, 2019
Merged
[jaxrs-spec] add Eclipse MicroProfile file based approach#3901
wing328 merged 12 commits into
OpenAPITools:masterfrom 
jmini:add-app-servers
Conversation
@jmini
@jminijmini
commented
Sep 17, 2019

Copy link


Copy Markdown

Member
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

This was referenced Sep 17, 2019

Closed


Open

@wing328
wing328
commented
Sep 17, 2019

Copy link


Copy Markdown

Member
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"

@wing328wing328
added this to the 4.1.3 milestone
Sep 17, 2019
@wing328
wing328
commented
Sep 21, 2019•

edited

Loading

Copy link


Copy Markdown

Member
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
jmini
commented
Oct 1, 2019

Copy link


Copy Markdown

MemberAuthor
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
wing328
commented
Oct 1, 2019

Copy link


Copy Markdown

Member
Looks good now 👍
@wing328
wing328
merged commit d2b2998
into
OpenAPITools:masterOct 1, 2019
Jesse0Michael pushed a commit
to Jesse0Michael/openapi-generator
that referenced
this pull request
Oct 3, 2019
@jminiJesse Michael
[jaxrs-spec] add Eclipse MicroProfile file based approach (OpenAPIToo…
a1555fd
…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
@jmini
Add petstore projects for helidon, openliberty, quarkus and thorntail
5d8c8c2
Introduced with PR OpenAPITools/openapi-generator#3901
@jminijmini
mentioned this pull request
Oct 4, 2019
 Merged

4 tasks
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


No reviews


Assignees


No one assigned


Labels

Enhancement: FeatureServer: Java

Projects


None yet


Milestone

4.1.3

Development

Successfully merging this pull request may close these issues.

2 participants

@jmini@wing328

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
[jaxrs-spec] add Eclipse MicroProfile file based approach - #3901
Merged
wing328 merged 12 commits into
OpenAPITools:masterfrom 
jmini:add-app-servers
Oct 1, 2019
Merged
[jaxrs-spec] add Eclipse MicroProfile file based approach#3901
wing328 merged 12 commits into
OpenAPITools:masterfrom 
jmini:add-app-servers
Conversation
@jmini
@jminijmini
commented
Sep 17, 2019

Copy link


Copy Markdown

Member
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

This was referenced Sep 17, 2019

Closed


Open

@wing328
wing328
commented
Sep 17, 2019

Copy link


Copy Markdown

Member
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"

@wing328wing328
added this to the 4.1.3 milestone
Sep 17, 2019
@wing328
wing328
commented
Sep 21, 2019•

edited

Loading

Copy link


Copy Markdown

Member
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
jmini
commented
Oct 1, 2019

Copy link


Copy Markdown

MemberAuthor
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
wing328
commented
Oct 1, 2019

Copy link


Copy Markdown

Member
Looks good now 👍
@wing328
wing328
merged commit d2b2998
into
OpenAPITools:masterOct 1, 2019
Jesse0Michael pushed a commit
to Jesse0Michael/openapi-generator
that referenced
this pull request
Oct 3, 2019
@jminiJesse Michael
[jaxrs-spec] add Eclipse MicroProfile file based approach (OpenAPIToo…
a1555fd
…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
@jmini
Add petstore projects for helidon, openliberty, quarkus and thorntail
5d8c8c2
Introduced with PR OpenAPITools/openapi-generator#3901
@jminijmini
mentioned this pull request
Oct 4, 2019
 Merged

4 tasks
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


No reviews


Assignees


No one assigned


Labels

Enhancement: FeatureServer: Java

Projects


None yet


Milestone

4.1.3

Development

Successfully merging this pull request may close these issues.

2 participants

@jmini@wing328

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
[jaxrs-spec] add Eclipse MicroProfile file based approach - #3901
Merged
wing328 merged 12 commits into
OpenAPITools:masterfrom 
jmini:add-app-servers
Oct 1, 2019
Merged
[jaxrs-spec] add Eclipse MicroProfile file based approach#3901
wing328 merged 12 commits into
OpenAPITools:masterfrom 
jmini:add-app-servers
Conversation
@jmini
@jminijmini
commented
Sep 17, 2019

Copy link


Copy Markdown

Member
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

This was referenced Sep 17, 2019

Closed


Open

@wing328
wing328
commented
Sep 17, 2019

Copy link


Copy Markdown

Member
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"

@wing328wing328
added this to the 4.1.3 milestone
Sep 17, 2019
@wing328
wing328
commented
Sep 21, 2019•

edited

Loading

Copy link


Copy Markdown

Member
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
jmini
commented
Oct 1, 2019

Copy link


Copy Markdown

MemberAuthor
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
wing328
commented
Oct 1, 2019

Copy link


Copy Markdown

Member
Looks good now 👍
@wing328
wing328
merged commit d2b2998
into
OpenAPITools:masterOct 1, 2019
Jesse0Michael pushed a commit
to Jesse0Michael/openapi-generator
that referenced
this pull request
Oct 3, 2019
@jminiJesse Michael
[jaxrs-spec] add Eclipse MicroProfile file based approach (OpenAPIToo…
a1555fd
…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
@jmini
Add petstore projects for helidon, openliberty, quarkus and thorntail
5d8c8c2
Introduced with PR OpenAPITools/openapi-generator#3901
@jminijmini
mentioned this pull request
Oct 4, 2019
 Merged

4 tasks
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


No reviews


Assignees


No one assigned


Labels

Enhancement: FeatureServer: Java

Projects


None yet


Milestone

4.1.3

Development

Successfully merging this pull request may close these issues.

2 participants

@jmini@wing328

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
[jaxrs-spec] add Eclipse MicroProfile file based approach - #3901
Merged
wing328 merged 12 commits into
OpenAPITools:masterfrom 
jmini:add-app-servers
Oct 1, 2019
Merged
[jaxrs-spec] add Eclipse MicroProfile file based approach#3901
wing328 merged 12 commits into
OpenAPITools:masterfrom 
jmini:add-app-servers
Conversation
@jmini
@jminijmini
commented
Sep 17, 2019

Copy link


Copy Markdown

Member
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

This was referenced Sep 17, 2019

Closed


Open

@wing328
wing328
commented
Sep 17, 2019

Copy link


Copy Markdown

Member
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"

@wing328wing328
added this to the 4.1.3 milestone
Sep 17, 2019
@wing328
wing328
commented
Sep 21, 2019•

edited

Loading

Copy link


Copy Markdown

Member
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
jmini
commented
Oct 1, 2019

Copy link


Copy Markdown

MemberAuthor
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
wing328
commented
Oct 1, 2019

Copy link


Copy Markdown

Member
Looks good now 👍
@wing328
wing328
merged commit d2b2998
into
OpenAPITools:masterOct 1, 2019
Jesse0Michael pushed a commit
to Jesse0Michael/openapi-generator
that referenced
this pull request
Oct 3, 2019
@jminiJesse Michael
[jaxrs-spec] add Eclipse MicroProfile file based approach (OpenAPIToo…
a1555fd
…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
@jmini
Add petstore projects for helidon, openliberty, quarkus and thorntail
5d8c8c2
Introduced with PR OpenAPITools/openapi-generator#3901
@jminijmini
mentioned this pull request
Oct 4, 2019
 Merged

4 tasks
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


No reviews


Assignees


No one assigned


Labels

Enhancement: FeatureServer: Java

Projects


None yet


Milestone

4.1.3

Development

Successfully merging this pull request may close these issues.

2 participants

@jmini@wing328