Skip to content

Commit

Permalink
Update quickstart documentation regarding archetype
Browse files Browse the repository at this point in the history
closes: #248
  • Loading branch information
erdlet committed Apr 30, 2021
1 parent a47b665 commit 9cd6276
Showing 1 changed file with 38 additions and 6 deletions.
44 changes: 38 additions & 6 deletions documentation/src/main/asciidoc/_quickstart.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,35 +33,65 @@ The easiest way getting started with Eclipse Krazo is to generate a Jakarta EE p
archetype. This archetype generates a simple project including the Jakarta EE Web Profile and the selected,
server-specific Krazo implementation.
This archetype will use Jakarta EE 8 until version 1.1.0 of Krazo and Jakarta EE 9 since version 2.0.0.
===== How to use the archetype
The usage of the archetype is really easy. Depending on your application server, just run one of these commands in your command line.
====== Glassfish / Payara (Jersey)
For Java EE 8 / Jakarta EE 8:
[source, subs="attributes"]
....
----
mvn archetype:generate \
-DarchetypeGroupId=org.eclipse.krazo \
-DarchetypeArtifactId=krazo-jakartaee8-archetype \
-DarchetypeVersion={krazo-version} \
-DgroupId=YOUR GROUP ID\
-DartifactId=YOUR ARTIFACT ID
....
----
====== Wildfly (RESTEasy)
For Jakarta EE 9:
[source, subs="attributes"]
....
----
mvn archetype:generate \
-DarchetypeGroupId=org.eclipse.krazo \
-DarchetypeArtifactId=krazo-jakartaee9-archetype \
-DarchetypeVersion={krazo-version} \
-DgroupId=YOUR GROUP ID\
-DartifactId=YOUR ARTIFACT ID
----
====== Wildfly (RESTEasy) / OpenLiberty 21.* and newer
For Java EE 8 / Jakarta EE 8:
[source, subs="attributes"]
----
mvn archetype:generate \
-DarchetypeGroupId=org.eclipse.krazo \
-DarchetypeArtifactId=krazo-jakartaee8-archetype \
-DarchetypeVersion={krazo-version} \
-DgroupId=YOUR GROUP ID \
-DartifactId=YOUR ARTIFACT ID \
-DkrazoImpl=resteasy
....
----
For Jakarta EE 9:
[source, subs="attributes"]
----
mvn archetype:generate \
-DarchetypeGroupId=org.eclipse.krazo \
-DarchetypeArtifactId=krazo-jakartaee9-archetype \
-DarchetypeVersion={krazo-version} \
-DgroupId=YOUR GROUP ID \
-DartifactId=YOUR ARTIFACT ID \
-DkrazoImpl=resteasy
----
====== TomEE / OpenLiberty (CXF)
Krazo won't support CXF anymore. As OpenLiberty is going to switch to RESTEasy until it supports Jakarta REST Web Services 3.0, this change is only relevant for TomEE in general and older versions of OpenLiberty.
Expand Down Expand Up @@ -117,7 +147,7 @@ application:
</dependency>
----
====== Wildfly and JBoss EAP
====== Wildfly, JBoss EAP and OpenLiberty 21.*
Wildfly is using RESTEasy for JAX-RS. So you need the Eclipse Krazo RESTEasy integration module:
Expand All @@ -135,6 +165,8 @@ Wildfly is using RESTEasy for JAX-RS. So you need the Eclipse Krazo RESTEasy int
</dependency>
----
In the future, OpenLiberty will use RESTEasy also, so it will have the same setup.
====== Apache TomEE
To use Krazo on TomEE, you can add RESTEasy as a compile time dependency, as CXF isn't supported anymore by Krazo.
Expand Down

0 comments on commit 9cd6276

Please sign in to comment.