org.apache.camel.spi

Interface RestApiProcessorFactory

public interface RestApiProcessorFactory

Allows SPI to plugin a RestApiProcessorFactory that creates the Camel Processor responsible for servicing and generating the REST API documentation.

For example the camel-swagger-java component provides such a factory that uses Swagger to generate the documentation.

Method Summary

Modifier and Type	Method and Description
Processor	createApiProcessor(CamelContext camelContext, String contextPath, String contextIdPattern, boolean contextIdListing, RestConfiguration configuration, Map<String,Object> parameters) Creates a new REST API Processor , which provides API listing of the REST services

Method Detail

createApiProcessor

Processor createApiProcessor(CamelContext camelContext,
                             String contextPath,
                             String contextIdPattern,
                             boolean contextIdListing,
                             RestConfiguration configuration,
                             Map<String,Object> parameters)
                      throws Exception

Creates a new REST API Processor , which provides API listing of the REST services

Parameters:

camelContext - the camel context

contextPath - the context-path

contextIdPattern - id pattern to only allow Rest APIs from rest services within CamelContext's which name matches the pattern.

parameters - additional parameters

Returns:

a newly created REST API provider

Throws:

Exception - can be thrown