Package org.apache.camel.builder.endpoint.dsl

Interface RestOpenApiEndpointBuilderFactory.RestOpenApiEndpointConsumerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
All Known Subinterfaces:
RestOpenApiEndpointBuilderFactory.RestOpenApiEndpointBuilder
Enclosing interface:
RestOpenApiEndpointBuilderFactory
public static interface RestOpenApiEndpointBuilderFactory.RestOpenApiEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the REST OpenApi component.

  • Method Details

    • advanced

      default RestOpenApiEndpointBuilderFactory.AdvancedRestOpenApiEndpointConsumerBuilder advanced()

    • apiContextPath

      default RestOpenApiEndpointBuilderFactory.RestOpenApiEndpointConsumerBuilder apiContextPath(String apiContextPath)
      Sets the context-path to use for servicing the OpenAPI specification. The option is a: java.lang.String type. Group: consumer
      Parameters:
      apiContextPath - the value to set
      Returns:
      the dsl builder

    • clientRequestValidation

      default RestOpenApiEndpointBuilderFactory.RestOpenApiEndpointConsumerBuilder clientRequestValidation(boolean clientRequestValidation)
      Whether to enable validation of the client request to check if the incoming request is valid according to the OpenAPI specification. The option is a: boolean type. Default: false Group: consumer
      Parameters:
      clientRequestValidation - the value to set
      Returns:
      the dsl builder

    • clientRequestValidation

      default RestOpenApiEndpointBuilderFactory.RestOpenApiEndpointConsumerBuilder clientRequestValidation(String clientRequestValidation)
      Whether to enable validation of the client request to check if the incoming request is valid according to the OpenAPI specification. The option will be converted to a boolean type. Default: false Group: consumer
      Parameters:
      clientRequestValidation - the value to set
      Returns:
      the dsl builder

    • consumes

      default RestOpenApiEndpointBuilderFactory.RestOpenApiEndpointConsumerBuilder consumes(String consumes)
      What payload type this component capable of consuming. Could be one type, like application/json or multiple types as application/json, application/xml; q=0.5 according to the RFC7231. This equates or multiple types as application/json, application/xml; q=0.5 according to the RFC7231. This equates to the value of Accept HTTP header. If set overrides any value found in the OpenApi specification and. in the component configuration. The option is a: java.lang.String type. Group: consumer
      Parameters:
      consumes - the value to set
      Returns:
      the dsl builder

    • missingOperation

      default RestOpenApiEndpointBuilderFactory.RestOpenApiEndpointConsumerBuilder missingOperation(String missingOperation)
      Whether the consumer should fail,ignore or return a mock response for OpenAPI operations that are not mapped to a corresponding route. The option is a: java.lang.String type. Default: fail Group: consumer
      Parameters:
      missingOperation - the value to set
      Returns:
      the dsl builder