Skip to main content

Basic Usage

Signature

Type Safety

The @Resource decorator validates at compile time that the decorated class extends ResourceContext. Using it on a plain class produces a descriptive compile error. The same applies to @ResourceTemplate.

Configuration Options

Required Properties

Optional Properties

URI Schemes

Resources can use any valid URI scheme:

Return Format

Resources must return ReadResourceResult:

Text Content

Binary Content

Function-Based Alternative

Context Methods

The ResourceContext base class provides:

Full Example

@ResourceTemplate

Dynamic URI templates

ResourceContext

Context class details

ResourceRegistry

Resource registry API

Resource Errors

Resource-related errors