12.12. RESTEasy JavaScript API

12.12.1. About the RESTEasy JavaScript API

RESTEasy can generate a JavaScript API that uses AJAX calls to invoke JAX-RS operations. Each JAX-RS resource class will generate a JavaScript object of the same name as the declaring class or interface. The JavaScript object contains each JAX-RS method as properties.

Example 12.15. Simple JAX-RS JavaScript API Example

@Path("/")
public interface X{
 @GET
 public String Y();
 @PUT
 public void Z(String entity);
}

The interface above defines the methods Y and Z, which become properties in the JavaScript API, shown below:
var X = {
 Y : function(params){...},
 Z : function(params){...}
};

Each JavaScript API method takes an optional object as single parameter where each property is a cookie, header, path, query or form parameter as identified by their name, or the API parameter properties. The properties are available here: Section 12.12.3, “RESTEasy Javascript API Parameters”.