First of all for a JAX-RS application must be set a base URI from which all the resources will be available.
For that purpose the javax.ws.rs.core.Application
class must be extended and annotated with the javax.ws.rs.ApplicationPath
annotation. The annotation accepts a string argument which defines the base URI.
@ApplicationPath(JaxRsActivator.ROOT_PATH)
public class JaxRsActivator extends Application {
/**
* JAX-RS root path.
*/
public static final String ROOT_PATH = "/api";
}
Resources are simple POJO classes which are annotated with the @Path
annotation.
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
@Path("/hello")
public class HelloWorldResource {
public static final String MESSAGE = "Hello StackOverflow!";
@GET
@Produces("text/plain")
public String getHello() {
return MESSAGE;
}
}
When a HTTP GET
request is sent to /hello
, the resource responds with a Hello StackOverflow!
message.