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

Interface RestOpenApiEndpointBuilderFactory.RestOpenApiEndpointBuilder

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

  • Method Details

    • advanced

      default RestOpenApiEndpointBuilderFactory.AdvancedRestOpenApiEndpointBuilder advanced()

    • basePath

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

    • componentName

      default RestOpenApiEndpointBuilderFactory.RestOpenApiEndpointBuilder componentName(String componentName)
      Name of the Camel component that will perform the requests. The component must be present in Camel registry and it must implement RestProducerFactory service provider interface. If not set CLASSPATH is searched for single component that implements RestProducerFactory SPI. Overrides component configuration. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      componentName - the value to set
      Returns:
      the dsl builder

    • consumes

      default RestOpenApiEndpointBuilderFactory.RestOpenApiEndpointBuilder 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 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: <code>java.lang.String</code> type. Group: producer
      Parameters:
      consumes - the value to set
      Returns:
      the dsl builder

    • host

      default RestOpenApiEndpointBuilderFactory.RestOpenApiEndpointBuilder 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: <code>java.lang.String</code> type. Group: producer
      Parameters:
      host - the value to set
      Returns:
      the dsl builder

    • produces

      default RestOpenApiEndpointBuilderFactory.RestOpenApiEndpointBuilder 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: <code>java.lang.String</code> type. Group: producer
      Parameters:
      produces - the value to set
      Returns:
      the dsl builder

    • requestValidationCustomizer

      default RestOpenApiEndpointBuilderFactory.RestOpenApiEndpointBuilder requestValidationCustomizer(org.apache.camel.component.rest.openapi.validator.RequestValidationCustomizer requestValidationCustomizer)
      If request validation is enabled, this option provides the capability to customize the creation of OpenApiInteractionValidator used to validate requests. The option is a: <code>org.apache.camel.component.rest.openapi.validator.RequestValidationCustomizer</code> type. Default: org.apache.camel.component.rest.openapi.validator.DefaultRequestValidationCustomizer Group: producer
      Parameters:
      requestValidationCustomizer - the value to set
      Returns:
      the dsl builder

    • requestValidationCustomizer

      default RestOpenApiEndpointBuilderFactory.RestOpenApiEndpointBuilder requestValidationCustomizer(String requestValidationCustomizer)
      If request validation is enabled, this option provides the capability to customize the creation of OpenApiInteractionValidator used to validate requests. The option will be converted to a <code>org.apache.camel.component.rest.openapi.validator.RequestValidationCustomizer</code> type. Default: org.apache.camel.component.rest.openapi.validator.DefaultRequestValidationCustomizer Group: producer
      Parameters:
      requestValidationCustomizer - the value to set
      Returns:
      the dsl builder

    • requestValidationEnabled

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

    • requestValidationEnabled

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

    • requestValidationLevels

      default RestOpenApiEndpointBuilderFactory.RestOpenApiEndpointBuilder requestValidationLevels(String key, Object value)
      Levels for specific OpenAPI request validation options. Multiple options can be specified as URI options prefixed by 'validation.'. For example, validation.request.body=ERROR&amp;validation.request.body.unexpected=IGNORED. Supported values are INFO, ERROR, WARN &amp; IGNORE. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the requestValidationLevels(String, Object) method to add a value (call the method multiple times to set more values). Group: producer
      Parameters:
      key - the option key
      value - the option value
      Returns:
      the dsl builder

    • requestValidationLevels

      default RestOpenApiEndpointBuilderFactory.RestOpenApiEndpointBuilder requestValidationLevels(Map values)
      Levels for specific OpenAPI request validation options. Multiple options can be specified as URI options prefixed by 'validation.'. For example, validation.request.body=ERROR&amp;validation.request.body.unexpected=IGNORED. Supported values are INFO, ERROR, WARN &amp; IGNORE. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the requestValidationLevels(String, Object) method to add a value (call the method multiple times to set more values). Group: producer
      Parameters:
      values - the values
      Returns:
      the dsl builder