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

Interface RestOpenApiEndpointBuilderFactory.RestOpenApiEndpointProducerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
All Known Subinterfaces:
RestOpenApiEndpointBuilderFactory.RestOpenApiEndpointBuilder
Enclosing interface:
RestOpenApiEndpointBuilderFactory
public static interface RestOpenApiEndpointBuilderFactory.RestOpenApiEndpointProducerBuilder extends org.apache.camel.builder.EndpointProducerBuilder
Builder for endpoint producers for the REST OpenApi component.

  • Method Details

    • advanced

      default RestOpenApiEndpointBuilderFactory.AdvancedRestOpenApiEndpointProducerBuilder advanced()

    • basePath

      default RestOpenApiEndpointBuilderFactory.RestOpenApiEndpointProducerBuilder basePath(String basePath)
      API basePath, for example /v3. Default is unset, if set overrides the value present in OpenApi specification and in the component configuration. The option is a: java.lang.String type. Group: producer
      Parameters:
      basePath - the value to set
      Returns:
      the dsl builder

    • host

      default RestOpenApiEndpointBuilderFactory.RestOpenApiEndpointProducerBuilder host(String host)
      Scheme hostname and port to direct the HTTP requests to in the form of https://hostname:port. Can be configured at the endpoint, component or in the corresponding REST configuration in the Camel Context. If you give this component a name (e.g. petstore) that REST configuration is consulted first, rest-openapi next, and global configuration last. If set overrides any value found in the OpenApi specification, RestConfiguration. Overrides all other configuration. The option is a: java.lang.String type. Group: producer
      Parameters:
      host - the value to set
      Returns:
      the dsl builder

    • produces

      default RestOpenApiEndpointBuilderFactory.RestOpenApiEndpointProducerBuilder produces(String produces)
      What payload type this component is producing. For example application/json according to the RFC7231. This equates to the value of Content-Type HTTP header. If set overrides any value present in the OpenApi specification. Overrides all other configuration. The option is a: java.lang.String type. Group: producer
      Parameters:
      produces - the value to set
      Returns:
      the dsl builder

    • requestValidationEnabled

      default RestOpenApiEndpointBuilderFactory.RestOpenApiEndpointProducerBuilder requestValidationEnabled(boolean requestValidationEnabled)
      Enable validation of requests against the configured OpenAPI specification. The option is a: boolean type. Default: false Group: producer
      Parameters:
      requestValidationEnabled - the value to set
      Returns:
      the dsl builder

    • requestValidationEnabled

      default RestOpenApiEndpointBuilderFactory.RestOpenApiEndpointProducerBuilder requestValidationEnabled(String requestValidationEnabled)
      Enable validation of requests against the configured OpenAPI specification. The option will be converted to a boolean type. Default: false Group: producer
      Parameters:
      requestValidationEnabled - the value to set
      Returns:
      the dsl builder