Uses of Annotation Interface
org.apache.juneau.rest.server.Rest
Packages that use Rest
Package
Description
Engine-agnostic themeable admin-console chrome:
Theme, the stock
theme stylesheets, the bundled chrome.css asset, and
ConsoleChromeMixin.The DataTables server-side-processing JSON beans implementing the
DataTables server-side processing wire
contract.
A typed, declarative "rich DataTables view" toolkit that serializes to the frozen
VIEW_META JSON wire
contract consumed by the first-party client runtime.Reusable widget primitives for the Juneau REST server toolkit.
Example / demo Microservice REST Resources
Actuator-style management-surface endpoints (microservice-module flavors).
Petstore admin console: the
/console page tree.Petstore console Developer pages: custom cards, themes, rendering flavors and the secure API demo.
Petstore console Rendering flavors: one console page per petstore view technology.
Petstore console operations pages: background jobs and the audit log.
Petstore console orders page and its JSON endpoints.
Petstore console pets pages and their JSON endpoints.
Petstore console users page and its JSON endpoints.
Apache Juneau Petstore - Jetty/Microservice deployment.
Petstore REST resources.
Apache Juneau Petstore - Spring Boot deployment.
REST Server API
Predefined REST configuration interfaces
Convention-endpoints mixin pack — composable
@Rest(mixins=...) resources that ship the
"internet conventions" surface (favicon, robots, sitemap, version, well-known) every public-facing
service eventually grows.API-docs mixin pack — composable
@Rest(mixins=...) resources that publish Swagger v2
and OpenAPI 3.1 spec endpoints with Swagger-UI and Redoc HTML mounts.Built-in health, readiness, and liveness probe support for Juneau REST servers.
Actuator-style management-surface endpoints (server-module flavors).
Revision-neutral core for MCP endpoints built on
juneau-rest-server.MCP
2026-07-28 binding for juneau-rest-server-mcp.Micrometer bridge for the
juneau-rest-server
MetricsRecorder SPI.Ops / introspection mixin pack — composable
@Rest(mixins=...) resources that ship the
operational surface (request echo, JVM admin, route index) every long-running Juneau service
eventually grows.Predefined REST resource configuration interfaces that add RDF (Jena) marshalling support.
REST Servlets
Spring Boot Integration
REST Static Files Support
Engine-agnostic server-side-rendered view extension point.
Apache FreeMarker view-rendering bridge — opt-in
juneau-rest-server-view-freemarker
module.JSP view-rendering bridge — opt-in
juneau-rest-server-view-jsp module.Mustache view-rendering bridge — opt-in
juneau-rest-server-view-mustache module.Thymeleaf view-rendering bridge — opt-in
juneau-rest-server-view-thymeleaf module.Server Configuration REST
-
Uses of Rest in org.apache.juneau.console
Classes in org.apache.juneau.console with annotations of type RestModifier and TypeClassDescriptionclassMixin that serves the admin-console chrome stylesheet at/juneau-console/chrome.css. -
Uses of Rest in org.apache.juneau.console.datatables
Classes in org.apache.juneau.console.datatables with annotations of type RestModifier and TypeClassDescriptionclassMixin that serves Juneau's first-party DataTables glue script at/juneau-datatables.js. -
Uses of Rest in org.apache.juneau.console.views
Classes in org.apache.juneau.console.views with annotations of type RestModifier and TypeClassDescriptionclassMixin that serves the first-party rich-view runtime assets —juneau-views.js,juneau-ribbon.js,juneau-renders.js,juneau-views.css, the opt-injuneau-regions.jsregion-populate runtime, the opt-injuneau-config.js/juneau-config.csscolumn-chooser runtime — each at its stable path, plus deprecated compatibility mounts for the two assets that have since moved to the widget module. -
Uses of Rest in org.apache.juneau.console.widgets
Classes in org.apache.juneau.console.widgets with annotations of type RestModifier and TypeClassDescriptionclassThe widget toolkit's serving-path mixin: the mount, asset-URL API and serving endpoints for the widget-owned browser runtime (juneau-calendar.js,juneau-calendar.css), plus the contract-version handshake constants those runtimes bake in. -
Uses of Rest in org.apache.juneau.examples.mcp
Classes in org.apache.juneau.examples.mcp with annotations of type RestModifier and TypeClassDescriptionclassA complete, runnable MCP2026-07-28 server exposing every major surface of the protocol over one tiny, coherent scenario: an in-memorynotesservice. -
Uses of Rest in org.apache.juneau.examples.mcp.spring
Classes in org.apache.juneau.examples.mcp.spring with annotations of type RestModifier and TypeClassDescriptionclassThe Spring Boot flavor of the MCP server. -
Uses of Rest in org.apache.juneau.microservice.examples
Classes in org.apache.juneau.microservice.examples with annotations of type RestModifier and TypeClassDescriptionclassShows contents of the microservice configuration file, and updates it.classMicroservice debug utilities.classREST resource that allows access to a file system directory.classREST resource for viewing and accessing log files.classSample root REST resource.classProvides the capability to shut down this REST microservice through a REST call. -
Uses of Rest in org.apache.juneau.microservice.management
Classes in org.apache.juneau.microservice.management with annotations of type RestModifier and TypeClassDescriptionclassConvenience assembly of the Actuator-style management surface under a single configurable path prefix.classMixin flavor of the/infoendpoint: renders the running application's manifest (build/version/git metadata) resolved from the host bean store.classChild-resource flavor of the/infoendpoint. -
Uses of Rest in org.apache.juneau.petstore.console
Classes in org.apache.juneau.petstore.console with annotations of type RestModifier and TypeClassDescriptionclassAbout: what the petstore demonstrates, as prose cards, plus Juneau's REST utility beans shown against thePetdomain bean.classServes the console chrome assets (the structuralchrome.css, the stock theme packs andjuneau-console.js) at the context-root/juneau-console/*URLs that every console page links.classBase class for every petstore console page resource: registers the console FreeMarker mixin withbase.ftlhas chrome, and injects the sharedPetStore.classRoot of the petstore admin console, mounted at/consolebeside the/petstoreAPI and sharing itsPetStore.classThe Store page, the petstore dashboard, and the feeds its charts, tiles and fragments read. -
Uses of Rest in org.apache.juneau.petstore.console.dev
Classes in org.apache.juneau.petstore.console.dev with annotations of type RestModifier and TypeClassDescriptionclassCharts: the chart-core demo page, built withDevPageBuilders.charts()only (it has no template twin).classThe Custom cards page, which shows how an adopter writes a card type, and the feeds its cards read.classDashboard: the dashboard-chrome demo page, built withDevPageBuilders.dashboard(String, int)only.classData sources: a demo page built withDevPageBuilders.data()only (it has no template twin).classThe petstore console's Developer section: custom cards, themes, rendering flavors and the secure API demo.classThe bearer-token protected API behind the Secure page.classSecure: an open console page demonstrating the bearer-token guardedSecureApiRest.classThemes: the stock console themes and one custom token theme, switchable with?theme=. -
Uses of Rest in org.apache.juneau.petstore.console.dev.flavors
Classes in org.apache.juneau.petstore.console.dev.flavors with annotations of type RestModifier and TypeClassDescriptionclassRendering flavors: the same pet list rendered by each of the petstore's view technologies, inside the console.classThe Freemarker rendering flavor: the pet list rendered fromfragments/pets.ftlh.classThe Html rendering flavor: the pet list built with the HTML5 bean builder.classThe Mustache rendering flavor: the pet list rendered fromconsole/fragments/pets.mustache. -
Uses of Rest in org.apache.juneau.petstore.console.ops
Classes in org.apache.juneau.petstore.console.ops with annotations of type Rest -
Uses of Rest in org.apache.juneau.petstore.console.orders
Classes in org.apache.juneau.petstore.console.orders with annotations of type RestModifier and TypeClassDescriptionclassThe Orders page and its endpoints: the server-mode datatable query over BeanQuery, theapproveanddeliverstatus transitions, and the cancel dialog form with itsDELETE. -
Uses of Rest in org.apache.juneau.petstore.console.pets
Classes in org.apache.juneau.petstore.console.pets with annotations of type RestModifier and TypeClassDescriptionclassPending changes: the staged-edits table.classThe pets JSON endpoints (server-mode datatable query over BeanQuery, create/replace/delete, sell, stage, and the per-pet feeds), the Pets and Sold pages, the add/edit dialog form, and the P4 pet pages: Summary (inline edit), Photo, Orders (with a row detail, and one order selected at nav depth 4) and History, whose nav nodes the page appends underpetsasp<petId>ando<orderId>. -
Uses of Rest in org.apache.juneau.petstore.console.users
Classes in org.apache.juneau.petstore.console.users with annotations of type Rest -
Uses of Rest in org.apache.juneau.petstore.jetty
Classes in org.apache.juneau.petstore.jetty with annotations of type RestModifier and TypeClassDescriptionclassRoot router resource for the Jetty deployment. -
Uses of Rest in org.apache.juneau.petstore.rest
Classes in org.apache.juneau.petstore.rest with annotations of type RestModifier and TypeClassDescriptionclassPetstore CRUD REST resource.classPetstore React SPA demo — serves the no-build single-page React UI from the core classpath. -
Uses of Rest in org.apache.juneau.petstore.springboot
Classes in org.apache.juneau.petstore.springboot with annotations of type RestModifier and TypeClassDescriptionclassTiny REST resource that demonstrates Spring@Autowiredinjection into a Juneau@Restservlet under a Spring Boot deployment.classRoot router resource for the Spring Boot deployment. -
Uses of Rest in org.apache.juneau.rest.server
Fields in org.apache.juneau.rest.server declared as RestMethods in org.apache.juneau.rest.server that return RestModifier and TypeMethodDescriptionRestAnnotation.Builder.build()Instantiates a new@Restobject initialized with this builder.AbstractRestBuilder.toRestAnnotation()Returns the synthetic@Restannotation carrying all builder-set members, for use as the highest-priority contributor of the@Restresolution chain.Methods in org.apache.juneau.rest.server that return types with arguments of type RestModifier and TypeMethodDescriptionprotected Optional<AnnotationInfo<Rest>>RestContext.getRestAnnotation()Returns the nearestRestannotation on this resource.protected List<AnnotationInfo<Rest>>RestContext.getRestAnnotations()Returns allRestannotations on the resource class hierarchy, in child-to-parent order.protected List<AnnotationInfo<Rest>>RestContext.getRestAnnotationsTopDown()Returns theRestannotations for this resource in parent-to-child (top-down) order. -
Uses of Rest in org.apache.juneau.rest.server.config
Classes in org.apache.juneau.rest.server.config with annotations of type RestModifier and TypeInterfaceDescriptioninterfaceBasic configuration for a REST resource that supports JSON 5 transport.interfaceBasic configuration for a REST resource that supports JSON transport.interfaceBasic configuration for a REST resource that supports JSON and HTML transport.interfaceBasic configuration for a REST resource that supports OpenAPI transport.interfaceBasic configuration for a REST resource that supports Protobuf Text Format transport.interfaceBasic configuration for a REST resource that supports TOML transport.interfacePredefined configuration for a REST resource that supports all languages and provides common default configuration values.interfaceBasic configuration for a REST resource that supports YAML transport.interfacePredefined REST configuration that defines common default values for all configurations. -
Uses of Rest in org.apache.juneau.rest.server.convention
Classes in org.apache.juneau.rest.server.convention with annotations of type RestModifier and TypeClassDescriptionclassMixin that serves afavicon.icoicon at/favicon.ico.classChild-resource flavor of theFaviconMixinmixin.classStandalone servlet companion of theFaviconMixinmixin.classMixin that serves SEO-conventional endpoints/robots.txtand/sitemap.xml.classMixin that serves deployment-introspection metadata at/version(configurable).classChild-resource flavor of theVersionMixinversion/build-metadata capability.classStandalone servlet companion of theVersionMixinmixin.classMixin that serves RFC 8615/.well-known/*discovery endpoints. -
Uses of Rest in org.apache.juneau.rest.server.docs
Classes in org.apache.juneau.rest.server.docs with annotations of type RestModifier and TypeClassDescriptionclassMixin that publishes the OpenAPI 3.1 spec endpoints for a resource.classMixin that publishes the Redoc HTML view at/redocfor the OpenAPI 3.1 spec.classMixin that publishes the Swagger v2 spec endpoint at/api/*.classMixin that publishes the Swagger-UI HTML view at/swagger. -
Uses of Rest in org.apache.juneau.rest.server.health
Classes in org.apache.juneau.rest.server.health with annotations of type RestModifier and TypeClassDescriptionclassMixin flavor of the built-in health/readiness/liveness probe capability.classChild-resource flavor of the built-in health/readiness/liveness probe capability.classServlet flavor of the built-in health/readiness/liveness probe capability. -
Uses of Rest in org.apache.juneau.rest.server.management
Classes in org.apache.juneau.rest.server.management with annotations of type RestModifier and TypeClassDescriptionclassMixin flavor of the diagnostic dump endpoints (/threaddump,/heapdump).classChild-resource flavor of the diagnostic dump endpoints (/threaddump,/heapdump).classMixin flavor of the/loggersruntime log-level management endpoint.classChild-resource flavor of the/loggersruntime log-level management endpoint. -
Uses of Rest in org.apache.juneau.rest.server.mcp
Classes in org.apache.juneau.rest.server.mcp with annotations of type RestModifier and TypeClassDescriptionclassDrop-inBasicRestServletsubclass that exposes a single MCP JSON-RPC endpoint atPOST /. -
Uses of Rest in org.apache.juneau.rest.server.mcp.v20260728
Classes in org.apache.juneau.rest.server.mcp.v20260728 with annotations of type RestModifier and TypeClassDescriptionclassAbstract MCP servlet bound to protocol revision2026-07-28. -
Uses of Rest in org.apache.juneau.rest.server.metrics.micrometer
Classes in org.apache.juneau.rest.server.metrics.micrometer with annotations of type RestModifier and TypeClassDescriptionclassMixin flavor of the/metricsendpoint: renders a Prometheus scrape from a consumer-provided MicrometerMeterRegistryresolved from the host bean store.classChild-resource flavor of the/metricsendpoint. -
Uses of Rest in org.apache.juneau.rest.server.ops
Classes in org.apache.juneau.rest.server.ops with annotations of type RestModifier and TypeClassDescriptionclassMixin that serves operational-introspection endpoints under/admin/*: thread dump, heap statistics, configurable cache-flush hooks, and rate-limit-bucket inspection.classChild-resource flavor of theAdminMixinmixin.classStandalone servlet companion of theAdminMixinmixin.classMixin that serves a request-echo / round-trip introspection endpoint at/echo/*(configurable).classMixin providing the residual[* /error]endpoint.classMixin providing the residual[GET /htdocs/*]static-file endpoint.classMixin providing the group-navigation endpoint ([GET /]) that lists the host resource's child resources.classMixin that exposes a content-negotiated index of all@RestOp-annotated methods on the host resource (and any other mixins on it) at/options(configurable).classMixin providing the residual[GET /stats]timing-statistics endpoint. -
Uses of Rest in org.apache.juneau.rest.server.rdf.config
Classes in org.apache.juneau.rest.server.rdf.config with annotations of type RestModifier and TypeInterfaceDescriptioninterfaceIdentical toBasicUniversalConfigbut includes RDF marshalling support. -
Uses of Rest in org.apache.juneau.rest.server.servlet
Classes in org.apache.juneau.rest.server.servlet with annotations of type RestModifier and TypeClassDescriptionclassIdentical toBasicRestServletbut doesn't extend fromHttpServlet.classIdentical toBasicRestServletGroupbut doesn't extend fromHttpServlet.classSubclass ofRestServletwith default settings and standard endpoints defined.classSpecialized subclass ofBasicRestServletfor showing "group" pages. -
Uses of Rest in org.apache.juneau.rest.server.springboot
Classes in org.apache.juneau.rest.server.springboot with annotations of type RestModifier and TypeClassDescriptionclassSubclass ofSpringRestServletwith default settings and standard endpoints defined.classSpecialized subclass ofBasicSpringRestServletfor showing "group" pages. -
Uses of Rest in org.apache.juneau.rest.server.staticfile
Classes in org.apache.juneau.rest.server.staticfile with annotations of type RestModifier and TypeClassDescriptionclassMixin that serves static files from the activeStaticFilesimplementation under/static/*(configurable).classChild-resource flavor of the static-files capability.classStandalone servlet companion of theStaticFilesMixinmixin.classMixin that serves WebJar files from the classpath at/webjars/*. -
Uses of Rest in org.apache.juneau.rest.server.view
Classes in org.apache.juneau.rest.server.view with annotations of type RestModifier and TypeClassDescriptionclassAbstract base for the child-resource flavors of the view mixin resources.classAbstract base for the standalone view-servlet companions of the view mixin resources. -
Uses of Rest in org.apache.juneau.rest.server.view.freemarker
Classes in org.apache.juneau.rest.server.view.freemarker with annotations of type RestModifier and TypeClassDescriptionclassMixin that wires Apache FreeMarker view-rendering onto any Juneau REST resource.classChild-resource flavor of theFreemarkerMixinmixin.classStandalone servlet companion of theFreemarkerMixinmixin. -
Uses of Rest in org.apache.juneau.rest.server.view.jsp
Classes in org.apache.juneau.rest.server.view.jsp with annotations of type Rest -
Uses of Rest in org.apache.juneau.rest.server.view.mustache
Classes in org.apache.juneau.rest.server.view.mustache with annotations of type RestModifier and TypeClassDescriptionclassMixin that wires Mustache view-rendering onto any Juneau REST resource.classChild-resource flavor of theMustacheMixinmixin.classStandalone servlet companion of theMustacheMixinmixin. -
Uses of Rest in org.apache.juneau.rest.server.view.thymeleaf
Classes in org.apache.juneau.rest.server.view.thymeleaf with annotations of type RestModifier and TypeClassDescriptionclassMixin that wires Thymeleaf view-rendering onto any Juneau REST resource.classChild-resource flavor of theThymeleafMixinmixin.classStandalone servlet companion of theThymeleafMixinmixin. -
Uses of Rest in org.apache.juneau.server.config.rest
Classes in org.apache.juneau.server.config.rest with annotations of type RestModifier and TypeClassDescriptionclassREST resource for loading configuration from a Git repository.