alimulondo / resteasy

REST and JAXRS

RESTEasy

RESTEasy is a JBoss.org project aimed at providing productivity frameworks for developing client and server RESTful applications and services in Java. It is mainly a JAX-RS implementation but you'll find some other experimental code in the repository.

The project page can be found at https://resteasy.github.io.

JAX-RS

RESTEasy is a JBoss project that provides various frameworks to help you build RESTful Web Services and RESTful Java applications. It is a portable implementation of the JAX-RS specification. The full name of JAX-RS is Jakarta RESTful Web Services that provides a Java API for RESTful Web Services over the HTTP protocol. Please note that the specification is now under the Eclipse EE4J Project. You can read the entire specification at Jakarta RESTful Web Services.

Getting started with RESTEasy

• Read a book
• Check out the examples in the repository.
• Read the documentation.
• The blog is here.

Documentation

To read the documentation you can read it online.

Issues

Issues are kept in JIRA.

Build

Currently RESTEasy can be built with JDK 1.8 and 11.

If you want to purely build the project without running the tests, you need to pull down a clone of the RESTEasy repository and run:

$ mvn install -Dmaven.test.skip=true

If you want to build the project with testings run, you may need to specify a profile to use, and may need to configure the Wildfly version you want to run the tests with. Here is an example:

$ export SERVER_VERSION=17.0.0.Final
$ mvn -B -Pjboss-repository -fae -Dserver.version=$SERVER_VERSION install

You may want to check our Travis CI configuration to see our testing configuration matrix as build example.

And the example of full build processes can be checked here.

Contribute

You are most welcome to contribute to RESTEasy!

Read the Contribution guidelines