Package org.apache.juneau.rest.config

Interface BasicJsonHtmlConfig

All Superinterfaces:

DefaultConfig, DefaultHtmlConfig

public interface BasicJsonHtmlConfig
extends DefaultConfig, DefaultHtmlConfig

Basic configuration for a REST resource that supports JSON and HTML transport.

Default settings defined:

• Rest:
  • serializers:
    • JsonSerializer
    • Json5Serializer
    • HtmlDocSerializer
  • parsers:
    • JsonParser
    • Json5Parser
    • HtmlParser
  • defaultAccept: "text/json"
  • config: "$S{juneau.configFile,SYSTEM_DEFAULT}"
• BeanConfig:
  • ignoreUnknownBeanProperties: "true"
• SerializerConfig:
  • uriResolution: "ROOT_RELATIVE"
• HtmlDocConfig:
  • header: "<h1>$RS{title}</h><h2>$RS{operationSummary,description}</h2>$C{REST/header}"
  • navlinks: "up: request:/.."
  • stylesheet: "$C{REST/theme,servlet:/htdocs/themes/devops.css}"
  • head: "$C{REST/head}"
  • footer: "$C{REST/footer}"
  • nowrap: "true"

This annotation can be applied to REST resource classes to define common JSON default configurations:

// Used on a top-level resource. @Rest public class MyResource extends RestServlet implements BasicJsonHtmlConfig { ... }

// Used on a child resource. @Rest public class MyResource extends RestObject implements BasicJsonHtmlConfig { ... }

Note that the framework will aggregate annotations defined on all classes in the class hierarchy with values defined on child classes overriding values defined on parent classes. That allows any values defined on this interface to be overridden by annotations defined on the implemented class.

See Also:

• @Rest-Annotated Classes