View on GitHub RESTX     the lightweight Java REST framework
Improve This Page

RESTX Documentation

Welcome to RESTX documentation!

This documentation is still a work in progress, expect many improvements here in a near future.

And feel free to contribute, it's super easy: use the 'Improve This Page' button at the top of any doc page, edit the page, and submit a pull request!

If you are just starting with RESTX, there is a getting started page which will guide you through the steps required until you get your first RESTX enabled app running in your IDE. Don't worry, it shouln't take more than a few minutes!

Here is the full table of contents of the documentation:

Features

Install

Getting Started

Shell App Bootstrap

Manual App Bootstrap

IDE support

IntellIJ IDEA

Eclipse

Netbeans

Try generated App

Generated App Explained

External docs

Samples

Reference

RESTX Factory

RESTX HTTP

RESTX Lifecycle

RESTX Specs

RESTX Settings

RESTX Security

RESTX Errors Management

RESTX i18n

Deploying a RESTX app