Package 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-openapi-java component provides such a factory that uses OpenAPI/Swagger to generate
the documentation.-
Method Summary
Modifier and TypeMethodDescriptioncreateApiProcessor
(CamelContext camelContext, String contextPath, RestConfiguration configuration, Map<String, Object> parameters) Creates a new REST API Processor , which provides API listing of the REST services
-
Method Details
-
createApiProcessor
Processor createApiProcessor(CamelContext camelContext, String contextPath, RestConfiguration configuration, Map<String, Object> parameters) throws ExceptionCreates a new REST API Processor , which provides API listing of the REST services- Parameters:
camelContext
- the camel contextcontextPath
- the context-pathconfiguration
- the rest configurationparameters
- additional parameters- Returns:
- a newly created REST API provider
- Throws:
Exception
- can be thrown
-