org.apache.camel.builder.endpoint.dsl

Interface RestApiEndpointBuilderFactory.RestApiBuilders

All Known Subinterfaces:

EndpointBuilderFactory

All Known Implementing Classes:

EndpointRouteBuilder

Enclosing interface:

RestApiEndpointBuilderFactory

public static interface RestApiEndpointBuilderFactory.RestApiBuilders

Method Summary

Modifier and Type	Method and Description
default RestApiEndpointBuilderFactory.RestApiEndpointBuilder	restApi(String path) REST API (camel-rest) Expose OpenAPI Specification of the REST services defined using Camel REST DSL.
default RestApiEndpointBuilderFactory.RestApiEndpointBuilder	restApi(String componentName, String path) REST API (camel-rest) Expose OpenAPI Specification of the REST services defined using Camel REST DSL.

Method Detail

restApi

default RestApiEndpointBuilderFactory.RestApiEndpointBuilder restApi(String path)

REST API (camel-rest) Expose OpenAPI Specification of the REST services defined using Camel REST DSL. Category: core,rest Since: 2.16 Maven coordinates: org.apache.camel:camel-rest Syntax: rest-api:path/contextIdPattern Path parameter: path (required) The base path Path parameter: contextIdPattern Optional CamelContext id pattern to only allow Rest APIs from rest services within CamelContext's which name matches the pattern.

Parameters:

path - path/contextIdPattern

Returns:

the dsl builder

restApi

default RestApiEndpointBuilderFactory.RestApiEndpointBuilder restApi(String componentName,
                                                                     String path)

REST API (camel-rest) Expose OpenAPI Specification of the REST services defined using Camel REST DSL. Category: core,rest Since: 2.16 Maven coordinates: org.apache.camel:camel-rest Syntax: rest-api:path/contextIdPattern Path parameter: path (required) The base path Path parameter: contextIdPattern Optional CamelContext id pattern to only allow Rest APIs from rest services within CamelContext's which name matches the pattern.

Parameters:

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

path - path/contextIdPattern

Returns:

the dsl builder