Skip to content

TypedRest/TypedRest-Java

Repository files navigation

TypedRest for Java

TypedRest for Java helps you build type-safe, fluent-style REST API clients. Common REST patterns such as collections are represented as classes, allowing you to write more idiomatic code.

MyClient client = new MyClient(URI.create("http://example.com/"));

// GET /contacts
List<Contact> contactList = client.getContacts().readAll();

// POST /contacts -> Location: /contacts/1337
ContactEndpoint smith = client.getContacts().create(new Contact("Smith"));
//ContactEndpoint smith = client.getContacts().get("1337");

// GET /contacts/1337
Contact contact = smith.read();

// PUT /contacts/1337/note
smith.getNote().set(new Note("some note"));

// GET /contacts/1337/note
Note note = smith.getNote().read();

// DELETE /contacts/1337
smith.delete();

Read an Introduction to TypedRest or jump right in with the Getting started guide.

For information about specific Java classes or interfaces you can read the API Documentation.

Maven artifacts

Artifact group: com.oneandone

typedrest-core
The main TypedRest library.

typedrest-annotations
Annotations for data models to be used with TypedRest.

typedrest-vaadin
Build Vaadin GUIs for TypedRest clients.

typedrest-archetype
Maven archetype (template) for creating TypedRest projects.