Package org.apache.juneau.rest.config

Interface BasicOpenApiConfig

All Superinterfaces:

DefaultConfig

public interface BasicOpenApiConfig
extends DefaultConfig

Basic configuration for a REST resource that supports OpenAPI transport.

Default settings defined:

• Rest:
  • serializers:
    • OpenApiSerializer
  • parsers:
    • OpenApiParser
  • defaultAccept: "text/openapi"
  • config: "$S{juneau.configFile,SYSTEM_DEFAULT}"
• BeanConfig:
  • ignoreUnknownBeanProperties: "true"
• SerializerConfig:
  • uriResolution: "ROOT_RELATIVE"

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

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

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

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