Interface ApiEndpoint

All Superinterfaces:

AutoCloseable, ComponentAware, Endpoint, IsSingleton, Service

public interface ApiEndpoint
extends Endpoint

Marker interface indicating that an Endpoint belongs to an API-based component, where the endpoint URI encodes an API name and method name rather than a plain scheme and path.

API-based components (for example camel-box) are typically generated from an API specification and expose many operations as distinct endpoint URIs. This interface allows tooling and the Camel catalog to identify and document them as API endpoints.

Since:

3.6

See Also:

• Endpoint

Method Summary

Methods inherited from interface ComponentAware

getComponent, getComponent, setComponent

Methods inherited from interface Endpoint

configureExchange, configureProperties, createAsyncProducer, createConsumer, createExchange, createExchange, createPollingConsumer, createProducer, getCamelContext, getEndpointBaseUri, getEndpointKey, getEndpointUri, getExchangePattern, isLenientProperties, isRemote, isSingletonProducer, setCamelContext

Methods inherited from interface IsSingleton

isSingleton

Methods inherited from interface Service

build, close, init, start, stop