| Modifier and Type | Method and Description |
|---|---|
RestConfigurationProperties |
MainConfigurationProperties.rest()
To configure Rest DSL
|
RestConfigurationProperties |
RestConfigurationProperties.withApiComponent(String apiComponent)
The name of the Camel component to use as the REST API (such as swagger)
|
RestConfigurationProperties |
RestConfigurationProperties.withApiContextIdPattern(String apiContextIdPattern)
Deprecated.
|
RestConfigurationProperties |
RestConfigurationProperties.withApiContextListing(boolean apiContextListing)
Deprecated.
|
RestConfigurationProperties |
RestConfigurationProperties.withApiContextPath(String apiContextPath)
Sets a leading API context-path the REST API services will be using.
|
RestConfigurationProperties |
RestConfigurationProperties.withApiContextRouteId(String apiContextRouteId)
Sets the route id to use for the route that services the REST API.
|
RestConfigurationProperties |
RestConfigurationProperties.withApiHost(String apiHost)
To use a specific hostname for the API documentation (such as swagger or openapi)
This can be used to override the generated host with this configured hostname
|
RestConfigurationProperties |
RestConfigurationProperties.withApiProperty(String key,
Object value)
Adds a api property
|
RestConfigurationProperties |
RestConfigurationProperties.withApiVendorExtension(boolean apiVendorExtension)
Whether vendor extension is enabled in the Rest APIs.
|
RestConfigurationProperties |
RestConfigurationProperties.withBindingMode(String bindingMode)
Sets the binding mode to use.
|
RestConfigurationProperties |
RestConfigurationProperties.withClientRequestValidation(boolean clientRequestValidation)
Whether to enable validation of the client request to check:
1) Content-Type header matches what the Rest DSL consumes; returns HTTP Status 415 if validation error.
|
RestConfigurationProperties |
RestConfigurationProperties.withComponent(String component)
The Camel Rest component to use for the REST transport (consumer), such as netty-http, jetty, servlet, undertow.
|
RestConfigurationProperties |
RestConfigurationProperties.withComponentProperty(String key,
Object value)
Adds a component property
|
RestConfigurationProperties |
RestConfigurationProperties.withConsumerProperty(String key,
Object value)
Adds a consumer property
|
RestConfigurationProperties |
RestConfigurationProperties.withContextPath(String contextPath)
Sets a leading context-path the REST services will be using.
|
RestConfigurationProperties |
RestConfigurationProperties.withCorsHeader(String key,
String value)
Adds a CORS header property
|
RestConfigurationProperties |
RestConfigurationProperties.withDataFormatProperty(String key,
Object value)
Adds a data format property
|
RestConfigurationProperties |
RestConfigurationProperties.withEnableCORS(boolean enableCORS)
Whether to enable CORS headers in the HTTP response.
|
RestConfigurationProperties |
RestConfigurationProperties.withEndpointProperty(String key,
Object value)
Adds a endpoint property
|
RestConfigurationProperties |
RestConfigurationProperties.withHost(String host)
The hostname to use for exposing the REST service.
|
RestConfigurationProperties |
RestConfigurationProperties.withHostNameResolver(String hostNameResolver)
If no hostname has been explicit configured, then this resolver is used to compute the hostname the REST service
will be using.
|
RestConfigurationProperties |
RestConfigurationProperties.withJsonDataFormat(String jsonDataFormat)
Name of specific json data format to use.
|
RestConfigurationProperties |
RestConfigurationProperties.withPort(int port)
The port number to use for exposing the REST service.
|
RestConfigurationProperties |
RestConfigurationProperties.withProducerApiDoc(String producerApiDoc)
Sets the location of the api document (swagger api) the REST producer will use to validate the REST uri and query
parameters are valid accordingly to the api document.
|
RestConfigurationProperties |
RestConfigurationProperties.withProducerComponent(String producerComponent)
Sets the name of the Camel component to use as the REST producer
|
RestConfigurationProperties |
RestConfigurationProperties.withScheme(String scheme)
The scheme to use for exposing the REST service.
|
RestConfigurationProperties |
RestConfigurationProperties.withSkipBindingOnErrorCode(boolean skipBindingOnErrorCode)
Whether to skip binding on output if there is a custom HTTP error code header.
|
RestConfigurationProperties |
RestConfigurationProperties.withUseXForwardHeaders(boolean useXForwardHeaders)
Whether to use X-Forward headers for Host and related setting.
|
RestConfigurationProperties |
RestConfigurationProperties.withXmlDataFormat(String xmlDataFormat)
Name of specific XML data format to use.
|
Apache Camel