A Java client library for programmatic access to any SimplyRESTful API.
This client library provides Java-based programmatic access to any SimplyRESTful-based API.
- It requires only the Java classes of the API resources.
- The Java classes of the API resources are only required at runtime.
- The HTTP-based API access is mapped to simpler CRUD-based methods.
Create the client by providing
- the URI of this specific resource's API (e.g.
http://localhost/api/myresources/) - the class to which the resource should be deserialized. (e.g.
MyResource.class)
SimplyRESTfulClient<MyResource> client = new SimplyRESTfulClient<>(URI.create("http://localhost/api/myresources/"), MyResource.class)You can now use this client to retrieve resources from the API through the create(), read(), update(), delete(), list(), and stream() methods. See the javadoc on each method for more information.
Optionally, you can provide a pre-configured JAX-RS client for the client to use. One example where this may be needed, is if the default client does not support reading and writing JSON. You could configure the JAX-RS client with Jackson support for JSON before passing it to the constructor.
Client jaxrsClient = ClientBuilder.newBuilder().register(JacksonJsonProvider.class).build();
SimplyRESTfulClient<MyResource> client = new SimplyRESTfulClient<>(jaxrsClient, URI.create("http://localhost/api/myresources/"), MyResource.class)Since hypermedia controls may require a highly customized HTTP request, the client provides a hypermediaControl() method that simply provides you with a WebTarget object that is pre-configured with the URI to the API for convenience. It can be further configured with query parameters, HTTP headers and anything else required to correctly configure the request for that hypermedia control.