Package org.apache.camel.model.rest

Class OpenApiDefinition

java.lang.Object

org.apache.camel.model.OptionalIdentifiedDefinition<OpenApiDefinition>

org.apache.camel.model.rest.OpenApiDefinition

All Implemented Interfaces:

org.apache.camel.CamelContextAware, org.apache.camel.LineNumberAware, org.apache.camel.NamedNode, org.apache.camel.spi.HasCamelContext, org.apache.camel.spi.HasId, org.apache.camel.spi.IdAware

@Metadata(label="rest")
public class OpenApiDefinition
extends OptionalIdentifiedDefinition<OpenApiDefinition>

To use OpenApi as contract-first with Camel Rest DSL.

Constructor Summary

Constructors

Constructor	Description
OpenApiDefinition()

Method Summary

Modifier and Type	Method	Description
OpenApiDefinition	apiContextPath(String apiDoc)	Whether to enable api-doc that exposes the OpenAPI specification file as a REST endpoint.
OpenApiDefinition	disabled()	Whether to disable the OpenAPI entirely.
OpenApiDefinition	disabled(boolean disabled)	Whether to disable the OpenAPI entirely.
OpenApiDefinition	disabled(String disabled)	Whether to disable the OpenAPI entirely.
RestDefinition	end()
String	getApiContextPath()
String	getDisabled()
String	getLabel()
String	getMissingOperation()
String	getMockIncludePattern()
String	getRouteId()
String	getShortName()
String	getSpecification()
OpenApiDefinition	missingOperation(String missingOperation)	Whether to fail, ignore or return a mock response for OpenAPI operations that are not mapped to a corresponding route.
OpenApiDefinition	mockIncludePattern(String mockIncludePattern)	Used for inclusive filtering of mock data from directories.
OpenApiDefinition	routeId(String routeId)	Sets the id of the route
void	setApiContextPath(String apiContextPath)
void	setDisabled(String disabled)	Whether to disable all the REST services from the OpenAPI contract from the route during build time.
void	setMissingOperation(String missingOperation)	Whether to fail, ignore or return a mock response for OpenAPI operations that are not mapped to a corresponding route.
void	setMockIncludePattern(String mockIncludePattern)	Used for inclusive filtering of mock data from directories.
void	setRest(RestDefinition rest)
void	setRouteId(String routeId)	Sets the id of the route
void	setSpecification(String specification)
OpenApiDefinition	specification(String specification)	Path to the OpenApi specification file.

Methods inherited from class org.apache.camel.model.OptionalIdentifiedDefinition

description, getCamelContext, getCustomId, getDescription, getDescriptionText, getId, getLineNumber, getLocation, getNodePrefixId, getParent, hasCustomIdAssigned, id, idOrCreate, setCamelContext, setCustomId, setDescription, setGeneratedId, setId, setLineNumber, setLocation

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.camel.NamedNode

acceptDebugger

Constructor Details

OpenApiDefinition

public OpenApiDefinition()

Method Details

setRest

public void setRest(RestDefinition rest)

getShortName

public String getShortName()

getLabel

public String getLabel()

getSpecification

public String getSpecification()

setSpecification

public void setSpecification(String specification)

getApiContextPath

public String getApiContextPath()

setApiContextPath

public void setApiContextPath(String apiContextPath)

getDisabled

public String getDisabled()

setDisabled

public void setDisabled(String disabled)

Whether to disable all the REST services from the OpenAPI contract from the route during build time. Once an REST service has been disabled then it cannot be enabled later at runtime.

getMissingOperation

public String getMissingOperation()

setMissingOperation

public void setMissingOperation(String missingOperation)

Whether to fail, ignore or return a mock response for OpenAPI operations that are not mapped to a corresponding route.

getMockIncludePattern

public String getMockIncludePattern()

setMockIncludePattern

public void setMockIncludePattern(String mockIncludePattern)

Used for inclusive filtering of mock data from directories. The pattern is using Ant-path style pattern. Multiple patterns can be specified separated by comma.

getRouteId

public String getRouteId()

setRouteId

public void setRouteId(String routeId)

Sets the id of the route

specification

public OpenApiDefinition specification(String specification)

Path to the OpenApi specification file.

apiContextPath

public OpenApiDefinition apiContextPath(String apiDoc)

Whether to enable api-doc that exposes the OpenAPI specification file as a REST endpoint. This allows clients to obtain the specification from the running Camel application.

disabled

public OpenApiDefinition disabled(String disabled)

Whether to disable the OpenAPI entirely. Once the OpenAPI has been disabled then it cannot be enabled later at runtime.

disabled

public OpenApiDefinition disabled(boolean disabled)

Whether to disable the OpenAPI entirely. Once the OpenAPI has been disabled then it cannot be enabled later at runtime.

disabled

public OpenApiDefinition disabled()

Whether to disable the OpenAPI entirely. Once the OpenAPI has been disabled then it cannot be enabled later at runtime.

missingOperation

public OpenApiDefinition missingOperation(String missingOperation)

Whether to fail, ignore or return a mock response for OpenAPI operations that are not mapped to a corresponding route.

mockIncludePattern

public OpenApiDefinition mockIncludePattern(String mockIncludePattern)

Used for inclusive filtering of mock data from directories. The pattern is using Ant-path style pattern. Multiple patterns can be specified separated by comma.

routeId

public OpenApiDefinition routeId(String routeId)

Sets the id of the route

end

public RestDefinition end()