JAX-RS @Path URI Matching Example - RESTful web service

In JAX-RS you can use the @Path annotation to bind the URI pattern to java method
First We see the simple URL Pattern matching with @Path annotation
Simple URI Matching Pattern
package test.ws; import javax.ws.rs.GET; import javax.ws.rs.Path; import javax.ws.rs.core.Response; @Path("/persons") public class PersonRestService { @GET public Response getPerson() { return Response.status(200).entity("getPerson is called").build(); } @GET @Path("/ad") public Response getPersonAD() { return Response.status(200).entity("getPersonAD is called").build(); } } URI pattern : “/persons” Output : getPerson is called URI pattern : “/persons/ad” Output : getPersonAD is called
URI Matching and Request Parameter
The value within open brace "{" and close brace "}" represent a parameter and can be
acessed using @PathParam annotation for example.
package test.ws; import javax.ws.rs.GET; import javax.ws.rs.Path; import javax.ws.rs.PathParam; import javax.ws.rs.core.Response; @Path("/persons") public class PersonRestService { @GET @Path("{name}") public Response getUserByName(@PathParam("name") String name) { return Response.status(200).entity("getPersonByName is called, name : " + name).build(); } } URI Pattern : “/persons/wakil” getPersonByName is called, name : wakil URI Pattern : “/persons/ahmad” getPersonByName is called, name : ahmad
URI Matching and Regular Expression
@Path support complex URI matching with regular expression, via following expression
{" variable-name [ ":" regular-expression ] "}
package test.ws; import javax.ws.rs.GET; import javax.ws.rs.Path; import javax.ws.rs.PathParam; import javax.ws.rs.core.Response; @Path("/persons") public class PersonRestService { @GET @Path("{id : \\d+}") //support digit only public Response getPersonById(@PathParam("id") String id) { return Response.status(200).entity("getPersonById is called, id : " + id).build(); } @GET @Path("/personname/{personname : [a-zA-Z][a-zA-Z_0-9]}") public Response getPersonByPersonName(@PathParam("personname") String personname) { return Response.status(200).entity("getPersonByPersonName is called, personname : " + personname).build(); } @GET @Path("/books/{isbn : \\d+}") public Response getPersonBookByISBN(@PathParam("isbn") String isbn) { return Response.status(200).entity("getPersonBookByISBN is called, isbn : " + isbn).build(); } } URI Pattern : “/persons/999” getPersonById is called, id : 999 URI Pattern : “/persons/234456” getPersonById is called, id : 234456 URI Pattern : “/persons/personname/aaa” , failed, don’t match “[a-zA-Z][a-zA-Z_0-9]“, first character need “[a-zA-Z]“, second character need “[a-zA-Z_0-9]“. Could not find resource for relative : /users/personname/aaa URI Pattern : “/persons/personname/a9” getPersonByPersonName is called, username : a9 URI Pattern : “persons/books/1092” getPersonBookByISBN is called, isbn : 1092
@PathParam with multiple parameters
This example show how to inject multiple parameters into a java method
package test.ws; import javax.ws.rs.GET; import javax.ws.rs.Path; import javax.ws.rs.PathParam; import javax.ws.rs.core.Response; @Path("/persons") public class PersonRestService { @GET @Path("{year}/{month}/{day}") public Response getPersonRecord(@PathParam("year") int year, @PathParam("month") int month,@PathParam("day") int day) { String date = year + "/" + month + "/" + day; return Response.status(200).entity("getPersonRecord is called, year/month/day : " + date).build(); } } URI Pattern : “/persons/2012/05/30” Output : getPersonRecord is called, year/month/day : 2012/5/30