org.apache.camel.openapi

Class RestOpenApiSupport

java.lang.Object

org.apache.camel.openapi.RestOpenApiSupport

public class RestOpenApiSupport
extends Object

A support class for that allows SPI to plugin and offer OpenApi API service listings as part of the Camel component. This allows rest-dsl components such as servlet/jetty/netty-http to offer OpenApi API listings with minimal effort.

Constructor Summary

Constructors

Constructor and Description
RestOpenApiSupport()

Method Summary

Modifier and Type	Method and Description
protected RestDefinitionsResolver	createJmxRestDefinitionsResolver(org.apache.camel.CamelContext camelContext)
static String	getBasePathFromOasDocument(io.apicurio.datamodels.openapi.models.OasDocument openapi)
static String	getHostFromOasDocument(io.apicurio.datamodels.openapi.models.OasDocument openapi)
List<org.apache.camel.model.rest.RestDefinition>	getRestDefinitions(org.apache.camel.CamelContext camelContext)
List<org.apache.camel.model.rest.RestDefinition>	getRestDefinitions(org.apache.camel.CamelContext camelContext, String camelId)
void	initOpenApi(BeanConfig openApiConfig, Map<String,Object> config)
static String	parseVariables(String url, io.apicurio.datamodels.openapi.v3.models.Oas30Server server)
void	renderCamelContexts(org.apache.camel.CamelContext camelContext, RestApiResponseAdapter response, String contextId, String contextIdPattern, boolean json, boolean yaml, org.apache.camel.spi.RestConfiguration configuration) Renders a list of available CamelContexts in the JVM
void	renderResourceListing(org.apache.camel.CamelContext camelContext, RestApiResponseAdapter response, BeanConfig openApiConfig, String contextId, String route, boolean json, boolean yaml, Map<String,Object> headers, org.apache.camel.spi.ClassResolver classResolver, org.apache.camel.spi.RestConfiguration configuration)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RestOpenApiSupport

public RestOpenApiSupport()

Method Detail

getHostFromOasDocument

public static String getHostFromOasDocument(io.apicurio.datamodels.openapi.models.OasDocument openapi)

getBasePathFromOasDocument

public static String getBasePathFromOasDocument(io.apicurio.datamodels.openapi.models.OasDocument openapi)

parseVariables

public static String parseVariables(String url,
                                    io.apicurio.datamodels.openapi.v3.models.Oas30Server server)

initOpenApi

public void initOpenApi(BeanConfig openApiConfig,
                        Map<String,Object> config)

getRestDefinitions

public List<org.apache.camel.model.rest.RestDefinition> getRestDefinitions(org.apache.camel.CamelContext camelContext)
                                                                    throws Exception

Throws:

Exception

getRestDefinitions

public List<org.apache.camel.model.rest.RestDefinition> getRestDefinitions(org.apache.camel.CamelContext camelContext,
                                                                           String camelId)
                                                                    throws Exception

Throws:

Exception

createJmxRestDefinitionsResolver

protected RestDefinitionsResolver createJmxRestDefinitionsResolver(org.apache.camel.CamelContext camelContext)

renderResourceListing

public void renderResourceListing(org.apache.camel.CamelContext camelContext,
                                  RestApiResponseAdapter response,
                                  BeanConfig openApiConfig,
                                  String contextId,
                                  String route,
                                  boolean json,
                                  boolean yaml,
                                  Map<String,Object> headers,
                                  org.apache.camel.spi.ClassResolver classResolver,
                                  org.apache.camel.spi.RestConfiguration configuration)
                           throws Exception

Throws:

Exception

renderCamelContexts

public void renderCamelContexts(org.apache.camel.CamelContext camelContext,
                                RestApiResponseAdapter response,
                                String contextId,
                                String contextIdPattern,
                                boolean json,
                                boolean yaml,
                                org.apache.camel.spi.RestConfiguration configuration)
                         throws Exception

Renders a list of available CamelContexts in the JVM

Throws:

Exception