Skip to main content

@Rest-Annotated Class Basics

The @Rest annotation is the primary way of defining and configuring REST resource classes.

The functionality of the class itself is covered in detail in the topics later.

RestallowedHeaderParams allowedMethodHeaders allowedMethodParams beanStore callLogger children clientVersionHeader config consumes converters debug debugEnablement debugOn defaultAccept defaultCharset defaultContentType defaultRequestAttributes defaultRequestHeaders defaultResponseHeaders description disableContentParam encoders guards maxInput messages on onClass parsers partParser partSerializer path produces renderResponseStackTraces responseProcessors restChildrenClass restOpArgs restOperationsClass roleGuard rolesDeclared serializers siteName staticFiles swagger swaggerProvider title uriAuthority uriContext uriRelativity uriResolution

The @Rest annotation in inheritable from parents and interfaces of resource classes.

When multiple annotations are defined at different levels, the annotation values are combined. This is a particularly useful feature because it allows you to define your own configured parent resource classes that can be extended by all your child resources so that they all share common settings.