Skip to main content

@Rest-Annotated Class

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 allowedParserOptions allowedSerializerOptions asyncCompletionExecutor asyncTimeoutMillis authenticator children childrenDefs clientVersionHeader config consumes converters defaultAccept defaultCharset defaultContentType defaultRequestAttributes defaultRequestHeaders defaultResponseHeaders description disableContentParam eagerInit encoders formDataParams guards headerParams lazyChildren maxInput messages mixinDefs mixins noInherit observability openApiProvider parsers partParser partSerializer path pathParams paths problemDetails produces queryParams renderResponseStackTraces responseProcessors restOpArgs roleGuard rolesDeclared serializers siteName staticFiles swagger swaggerProvider title uriAuthority uriContext uriRelativity uriResolution virtualThreads

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.

In This Section​