13.12. RESTEasy JavaScript API


13.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 13.15. Simple JAX-RS JavaScript API Example

@Path("/")
public interface X{
 @GET
 public String Y();
 @PUT
 public void Z(String entity);
}
Copy to Clipboard Toggle word wrap
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){...}
};
Copy to Clipboard Toggle word wrap
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 13.12.3, “RESTEasy Javascript API Parameters”.
Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat