org.apache.camel.builder.endpoint.dsl

Interface RestOpenApiEndpointBuilderFactory.RestOpenApiBuilders

All Known Subinterfaces:

EndpointBuilderFactory

All Known Implementing Classes:

EndpointRouteBuilder

Enclosing interface:

RestOpenApiEndpointBuilderFactory

public static interface RestOpenApiEndpointBuilderFactory.RestOpenApiBuilders

Method Summary

Modifier and Type	Method and Description
default RestOpenApiEndpointBuilderFactory.RestOpenApiEndpointBuilder	restOpenapi(String path) REST OpenApi (camel-rest-openapi) Configure REST producers based on an OpenAPI specification document delegating to a component implementing the RestProducerFactory interface.
default RestOpenApiEndpointBuilderFactory.RestOpenApiEndpointBuilder	restOpenapi(String componentName, String path) REST OpenApi (camel-rest-openapi) Configure REST producers based on an OpenAPI specification document delegating to a component implementing the RestProducerFactory interface.

Method Detail

restOpenapi

default RestOpenApiEndpointBuilderFactory.RestOpenApiEndpointBuilder restOpenapi(String path)

REST OpenApi (camel-rest-openapi) Configure REST producers based on an OpenAPI specification document delegating to a component implementing the RestProducerFactory interface. Category: openapi,rest,api Since: 3.1 Maven coordinates: org.apache.camel:camel-rest-openapi Syntax: rest-openapi:specificationUri#operationId Path parameter: specificationUri Path to the OpenApi specification file. The scheme, host base path are taken from this specification, but these can be overridden with properties on the component or endpoint level. If not given the component tries to load openapi.json resource from the classpath. Note that the host defined on the component and endpoint of this Component should contain the scheme, hostname and optionally the port in the URI syntax (i.e. http://api.example.com:8080). Overrides component configuration. The OpenApi specification can be loaded from different sources by prefixing with file: classpath: http: https:. Support for https is limited to using the JDK installed UrlHandler, and as such it can be cumbersome to setup TLS/SSL certificates for https (such as setting a number of javax.net.ssl JVM system properties). How to do that consult the JDK documentation for UrlHandler. Default value notice: By default loads openapi.json file Default value: openapi.json Path parameter: operationId (required) ID of the operation from the OpenApi specification.

Parameters:

path - specificationUri#operationId

Returns:

the dsl builder

restOpenapi

default RestOpenApiEndpointBuilderFactory.RestOpenApiEndpointBuilder restOpenapi(String componentName,
                                                                                 String path)

REST OpenApi (camel-rest-openapi) Configure REST producers based on an OpenAPI specification document delegating to a component implementing the RestProducerFactory interface. Category: openapi,rest,api Since: 3.1 Maven coordinates: org.apache.camel:camel-rest-openapi Syntax: rest-openapi:specificationUri#operationId Path parameter: specificationUri Path to the OpenApi specification file. The scheme, host base path are taken from this specification, but these can be overridden with properties on the component or endpoint level. If not given the component tries to load openapi.json resource from the classpath. Note that the host defined on the component and endpoint of this Component should contain the scheme, hostname and optionally the port in the URI syntax (i.e. http://api.example.com:8080). Overrides component configuration. The OpenApi specification can be loaded from different sources by prefixing with file: classpath: http: https:. Support for https is limited to using the JDK installed UrlHandler, and as such it can be cumbersome to setup TLS/SSL certificates for https (such as setting a number of javax.net.ssl JVM system properties). How to do that consult the JDK documentation for UrlHandler. Default value notice: By default loads openapi.json file Default value: openapi.json Path parameter: operationId (required) ID of the operation from the OpenApi specification.

Parameters:

componentName - to use a custom component name for the endpoint instead of the default name

path - specificationUri#operationId

Returns:

the dsl builder