Java API for RESTful Web Services (JAX-RS), is a set if APIs to developer REST service. JAX-RS is part of the Java EE6, and make developers to develop REST web application easily.
In this series of JAX-RS tutorials, we use both Jersey and RESTEasy, popular JAX-RS implementation.
Happy learning JAX-RS 🙂
Quick Start
Some quick start examples to use JAX-RS.
- Jersey hello world example
Jersey framework to create a simple REST style web application. - RESTEasy hello world example
RESTEasy framework to create a simple REST style web application.
Basic Examples
Basic annotations and functions to develop REST service.
- JAX-RS @Path URI matching example
JAX-RS URI matching examples. - JAX-RS @PathParam example
Simple way to inject URI parameter that defined in @Path into Java method. - JAX-RS @QueryParam example
Example to get query paremeter in URI path, and also how to define an optional paramater. - JAX-RS @MatrixParam example
Example to get matrix parameters in URI path. - JAX-RS @FormParam example
Example to get HTML post form parameter values. - Get HTTP headers in JAX-RS
Show the use of @HeaderParam and @Context to get HTTP headers. - Download text file from JAX-RS
Example to output a text file for user to download. - Download image file from JAX-RS
Example to output an image file for user to download. - Download pdf file from JAX-RS
Example to output pdf file for user to download. - Download excel file from JAX-RS
Example to output excel file for user to download.
File Upload Examples
How to handle multipart data in JAX-RS.
- File upload example in Jersey
File upload is easy in Jersey. - File upload example in RESTEasy
Two ways to handle file upload in RESTEasy.
Working with XML
XML support in JAX-RS.
- XML example with Jersey + JAXB
Jersey + JAXB to map object to and from XML. - XML example with RESTEasy + JAXB
RESTEasy + JAXB to map object to and from XML.
Working with JSON
JSON support in JAX-RS.
- JSON example with Jersey + Jackson
Jersey + Jackson to map object to and from JSON. - JSON example with RESTEasy + Jackson
RESTEasy + Jackson to map object to and from JSON. - JSON example with RESTEasy + JAXB + Jettison
RESTEasy + JAXB + Jettison to map object to and from JSON.
RESTful Java clients
Create a RESTful Java client to perform “GET” and “POST” request to manipulate json data.
- RESTful Java client with java.net.URL
- RESTful Java client with Apache HttpClient
- RESTful Java client with RESTEasy client
- RESTful Java client with Jersey client
JAX-RS + Spring
Integrate JAX-RS with Spring framework.
- Jersey + Spring integration example
Integrate Jersey with Spring framework. - RESTEasy + Spring integration example
Integrate RESTEasy with Spring framework.
Common Error Messages
Some common error messages in JAX-RS development.
- RESTEasy Unable to scan WEB-INF for JAX-RS annotations, Unexpected end of ZLIB input stream
- ClassNotFoundException : org.jboss.resteasy.plugins.providers.multipart.MultipartInput
- RESTEasy – Could not find message body reader for type: multipart/form-data
- RESTEasy – Could not find MessageBodyWriter for response object of type:xx of media type: application/xml
- Illegal to inject a message body into a singleton into public org.codehaus.jackson.jaxrs.JacksonJsonProvider
- Jersey : The ResourceConfig instance does not contain any root resource classes
- ClassNotFoundException : com.sun.jersey.spi.container.servlet.ServletContainer
Hi Mkyong,
Thanks for your wonderful tutorials but i want to know about REST Filter using ContainerRequestFilter(jersey 1.9).
I have tried and googled it but didn’t able to find anything related to Jersey 1.9 , every1 is saying about jersey 2.X.
Please can you provide this in your JAX RS tutorials or any other user knows about it please comment below.
Right, especially combining with Spring..
the closest thing is here: https://stackoverflow.com/questions/29430984/spring-jersey-filter-provider
But it also has Spring v2 involved and also has no solution
Thanks Mkyong..
Thanks 🙂 You Are Awesome
Where can I get the REST certification study material?
Yong, could you please tell me, how can we handle/get form parameters in REST service when they are in quantity approx. 15 params?
I am aware about @FormParam annotation, but if we cover all the 15 parameters, the method signature become quit long or we can say not readable.
Is there any way ? so that we can directly populate the object based on said 15 form parameters.
I heard about an annotation @Form objRef, but it is no longer exists.
please provide your thoughts on this
thanks,
-Roop
Thank you…!
thanks bro, you such savior
Hi Mkyong,
From long days i am trying to find good material for webservice development and finally i found on https://mkyong.com.
Thank you very much for your efforts.
Thanks
Rahul K
Thank you for your wonderful help..
Dear Mkyong
thanks for all your useful tutorials.
i’m java Developer from Tehran, Iran.
it my pleasure to appreciate to your tutorial and it is really useful.
Keep doing.
Best Regards
Typo: “set if APIs” should be “set of APIs”
More JAX-RS articles,
Apache CXF – REST : http://www.benchresources.net/web-services/apache-cxf-rest-tutorials/
JBoss RestEasy : http://www.benchresources.net/web-services/jboss-resteasy-tutorials/
Jersey 2.x : http://www.benchresources.net/web-services/jersey-2-tutorials/
Spring Restful : http://www.benchresources.net/web-services/spring-restful-tutorials/
I need help with using Java project dependency to other project :
I have a Project A and Project B .. Project B is calling Project A methods. While running on tomcat 8 . It does not return anything from Project A methods. I have added Project A to Java build path and deployment assembly of Project B .
I am using Maven , Tomcat 8 , Eclipse Mars.
Is jar of ProjectA in webapps lib of ProjectB in Tomcat?
i did it using maven’s parent module feature .. thanks for replying 🙂
Very helpful site! In particular I’ve been looking at your JAX-RS tutorials. I was wondering if you have an example of the appropriate way to use the @Produces annotation with an array. For example, depending on one of the QueryParams I’d like to return either xml or pdf.
you can use @Produces(MediaType.APPLICATION_OCTET_STREAM) and in return add header — header(“Content-Disposition”, “attachment; filename=” + “fileName.csv”)
I realized I should be using the Accept header to determine which format is returned rather than a QueryParam.
s/w versions used: TOMCAT 8, postgres 9.4, netbeans 8
@POST
@Override
@Consumes({“application/xml”, “application/json”})
public void create(Cdr entity)
{
super.create(entity);
}
public void create(T entity)
{
getEntityManager().persist(entity);
}
When we deploy a RESTful service prior to Servlet 3.0 container, we will configure the Servlet class in web.xml (<servlet-class>org.glassfish.jersey.servlet.ServletContainer</servlet-class>) to delegate the HTTP requests to the respective RESTful resource. But, in case of Servlet 3.0 container (web.xml is optional), how the request will be delegated to a RESTful resource. In this case we didn’t configure a Servlet class in web.xml.
If there are multiple JAX-RS implementation related JARs are added to the application library, then how the container will identify which implementation related Servlet class will handle this request?
Any suggestions are appreciated.
Wonderful tutorial, extremely helpful. Thank you very much.
How can I convert SOAP web service to REST web service(JSON) format ?
You can use jersey library for this
if use jersey, what can keep use tomcat web server ?
Have 2 questions, 1. How to perform authentication and authorization for rest services..? 2. How to maintain user sessions with REST ..? Please suggest what can be done to achieve this in REST
you can use filters in web.xml for authentication purpose . use of session is not preferred with REST you can use tokens.
I have a quiestion… ¿is posible integtrate resteasy with stateless EJB’s, using @EJB Annotation?
if I can use hibernate in Resteasy, I want to use hibernate in my project
Hi MkYong,
Thanks for your tutorials!! They are really informative. I couldn’t find any tutorial on Exception/error handling in REST as well as SOAP web service. It would be nice if you can share some example on this subject.
Cheers,
Neha
can you give the source code for Ejb + Jpa + Jsf + restful webservices.
I want to Insert data into Deployement Server Database using Restful Client
Thanks for your tutorials.
I have been following you for a very long time. It is always been very helpful and informative.
hi, i am a beginner i want to know the difference between web service and web application.. can u explain me in detail..
Thanks a lot for your valable service to the IT Community.Whenever i want to learn any new things, i used to visit your site..Thanks a lot..
How I can deploy Restfull web service on Apache tomcat server.
on web browser url if I write http://localhost:8080//index.jsp it display hello word.
but after writing http://localhost:8080/Energymeter/resources/generic1. it is giving servlet adapter exception
please tell me i can recover from this problem
Here is one simple example without maven
http://www.pretechsol.com/2013/06/java-restful-web-services-simple-example.html
These examples are simple,tells you how RESTful Web Service work on basics.
An invaluable resource, very easy to understand.My first step into jax-rs has been really because of this tutorials
Can you please provide an example where a xml payload is sent through REST POST method preferably using spring resttemplate