-
User guide
- Part 1 - Introduction
- Part 2 - Core Restlet
- Part 3 - Restlet Editions
- Part 4 - Restlet Extensions
- Appendices
- Tutorials
- Javadocs
- Change Log
Overview
User guide overview
This is the official User Guide for version 2.5 of the Restlet Framework.
This document is edited in a collaborative way via this GitHub repository as a set of Markdown pages.
Welcome to Restlet Framework! We hope that you will have as much fun learning and using this technology as we had designing and developing it. Be ready to radically change the way you think and build web applications. With Restlet in our backpack, we are certain that you will enter the REST and Web API world with the best toolkit available!
As a truly open source project, we not only consider you as a user but as a potential contributor. You will soon find ways to contribute back to the project, by filing a bug or enhancement reports, by submitting documentation or code improvements or by helping other users or developers in the mailing lists. Every contribution is valuable to the community and we give credit back to our team by listing all the contributors in the changes log.
Let’s get started and again: welcome to the Restlet Community !
Framework overview
Restlet is a comprehensive yet lightweight RESTful web API framework for Java that lets you embrace the architecture style of the Web (REST) and benefit from its simplicity and scalability. By using our innovative framework, you can start blending your web APIs, web sites and web clients into uniform web applications!
Restlet has a light core but thanks to its pluggable extension model, it is also a comprehensive REST framework for Java. It supports all REST concepts (Resource, Representation, Connector, Component, etc.) and is suitable for both client and server Web applications.
It supports major Web standards like HTTP, XML, JSON, OData, RDF, and Atom.
Many extensions are also available to integrate with Servlet, Spring, Jetty, JAXB, Velocity, FreeMarker, ThymeLeaf, Jackson, SLF4J, GSON and more!
Community support
If you can’t find an answer to your question in this document, please use our discussion forum and read the recommended books.
We especially recommend our Restlet in Action book published by Manning.
