JAX-RS Concepts

JAX-RS (JSR 311) is the latest JCP specification that provides a Java based API for REST Web services over the HTTP protocol. The JAX-RS specification is an annotation based server side API.

Apache Wink implements JAX-RS 1.0.

For those new to JAX-RS or developing REST applications, follow this in-progress user guide. If you have comments or questions, send an e-mail to the appropriate Apache Wink mailing lists.

While this user guide covers common scenarios, it is not intended to detail the JAX-RS specification itself. Please read the (brief yet understandable) specification if it is available to you.

Getting Started - A Simple JAX-RS Application

• Creating a Resource
• Creating a javax.ws.rs.core.Application sub-class
• Packaging Apache Wink with a Web Application
• Installation and Running the Application

Application Configuration

• javax.ws.rs.core.Application subclass
• Container environment information

Resources, HTTP Methods, and Paths

• Root Resource Methods
• javax.ws.rs.core.Response
• HTTP Methods
• Subresource Methods
• Subresource Locators
• Regular Expressions

Request and Response Entities (Message Bodies) and Media Types

• Produces/Consumes annotations
• ATOM
• XML
• JSON
• Standard Entity Parameter Types
• Custom application provided Message Body Readers/Writers
• Transfer Encoding
• Content Encoding

Parameters

• Query Parameters
• Path Parameters
• Matrix Parameters
• Header Parameters
• Cookie Parameters

HTTP Headers

• Common HTTP Request Headers
• Common HTTP Response Headers

Content Negotiation

• Using URIs to identify content type
• Using parameters to identify content type
• Using Accept headers

Using Request Context Information

• HTTP Headers
• URI Information
• Security Information
• Request
• Providers

Caching

• Expires
• Cache-Control