@Metadata(label="rest") public class RestDefinition extends OptionalIdentifiedDefinition<RestDefinition>
Constructor and Description |
---|
RestDefinition() |
Modifier and Type | Method and Description |
---|---|
RestDefinition |
apiDocs(Boolean apiDocs)
Include or exclude the current Rest Definition in API documentation.
|
static RouteDefinition |
asRouteApiDefinition(org.apache.camel.CamelContext camelContext,
org.apache.camel.spi.RestConfiguration configuration)
Transforms the rest api configuration into a
RouteDefinition which Camel routing
engine uses to service the rest api docs. |
List<RouteDefinition> |
asRouteDefinition(org.apache.camel.CamelContext camelContext)
Transforms this REST definition into a list of
RouteDefinition which Camel routing
engine can add and run. |
protected String |
asTypeName(Class<?> classType) |
RestDefinition |
bindingMode(RestBindingMode mode) |
RestDefinition |
bindingMode(String mode) |
String |
buildFromUri(VerbDefinition verb)
Build the from endpoint uri for the verb
|
RestDefinition |
clientRequestValidation(boolean clientRequestValidation) |
RestDefinition |
consumes(String mediaType) |
RestDefinition |
delete() |
RestDefinition |
delete(String uri) |
RestDefinition |
deprecated() |
RestDefinition |
description(String text)
Sets the description of this node
|
RestDefinition |
description(String id,
String text,
String lang)
Sets the description of this node
|
RestDefinition |
enableCORS(boolean enableCORS) |
RestDefinition |
get() |
RestDefinition |
get(String uri) |
String |
getApiDocs() |
String |
getBindingMode() |
String |
getClientRequestValidation() |
String |
getConsumes() |
String |
getEnableCORS() |
String |
getLabel() |
String |
getPath() |
String |
getProduces() |
RestSecuritiesDefinition |
getSecurityDefinitions() |
RestSecuritiesRequirement |
getSecurityRequirements() |
String |
getShortName() |
String |
getSkipBindingOnErrorCode() |
String |
getTag() |
List<VerbDefinition> |
getVerbs() |
RestDefinition |
head() |
RestDefinition |
head(String uri) |
RestDefinition |
id(String id)
Sets the id of this node.
|
RestDefinition |
outType(Class<?> classType) |
RestOperationParamDefinition |
param() |
RestDefinition |
param(RestOperationParamDefinition param) |
RestOperationParamDefinition |
param(VerbDefinition verb) |
RestDefinition |
params(List<RestOperationParamDefinition> params) |
RestDefinition |
patch() |
RestDefinition |
patch(String uri) |
RestDefinition |
path(String path)
To set the base path of this REST service
|
RestDefinition |
post() |
RestDefinition |
post(String uri) |
RestDefinition |
produces(String mediaType) |
RestDefinition |
put() |
RestDefinition |
put(String uri) |
RestOperationResponseMsgDefinition |
responseMessage() |
RestDefinition |
responseMessage(RestOperationResponseMsgDefinition msg) |
RestOperationResponseMsgDefinition |
responseMessage(VerbDefinition verb) |
RestDefinition |
responseMessages(List<RestOperationResponseMsgDefinition> msgs) |
RouteDefinition |
route() |
RestDefinition |
security(String key)
Sets the security setting for this verb.
|
RestDefinition |
security(String key,
String scopes)
Sets the security setting for this verb.
|
RestSecuritiesDefinition |
securityDefinitions()
To configure security definitions.
|
void |
setApiDocs(String apiDocs)
Whether to include or exclude the VerbDefinition in API documentation.
|
void |
setBindingMode(String bindingMode)
Sets the binding mode to use.
|
void |
setClientRequestValidation(String clientRequestValidation)
Whether to enable validation of the client request to check whether the Content-Type and Accept headers from the
client is supported by the Rest-DSL configuration of its consumes/produces settings.
|
void |
setConsumes(String consumes)
To define the content type what the REST service consumes (accept as input), such as application/xml or
application/json.
|
void |
setEnableCORS(String enableCORS)
Whether to enable CORS headers in the HTTP response.
|
void |
setPath(String path)
Path of the rest service, such as "/foo"
|
void |
setProduces(String produces)
To define the content type what the REST service produces (uses for output), such as application/xml or
application/json This option will override what may be configured on a parent level
|
void |
setSecurityDefinitions(RestSecuritiesDefinition securityDefinitions)
Sets the security definitions such as Basic, OAuth2 etc.
|
void |
setSecurityRequirements(RestSecuritiesRequirement securityRequirements)
Sets the security requirement(s) for all endpoints.
|
void |
setSkipBindingOnErrorCode(String skipBindingOnErrorCode)
Whether to skip binding on output if there is a custom HTTP error code header.
|
void |
setTag(String tag)
To configure a special tag for the operations within this rest definition.
|
void |
setVerbs(List<VerbDefinition> verbs)
The HTTP verbs this REST service accepts and uses
|
RestDefinition |
skipBindingOnErrorCode(boolean skipBindingOnErrorCode) |
RestDefinition |
tag(String tag)
To set the tag to use of this REST service
|
RestDefinition |
to(String uri)
Routes directly to the given static endpoint.
|
RestDefinition |
toD(String uri)
Routes directly to the given dynamic endpoint.
|
RestDefinition |
type(Class<?> classType) |
protected void |
validateUniquePaths() |
RestDefinition |
verb(String verb) |
RestDefinition |
verb(String verb,
String uri) |
getCustomId, getDescription, getDescriptionText, getId, getParent, hasCustomIdAssigned, idOrCreate, setCustomId, setDescription, setGeneratedId, setId
public String getShortName()
public String getLabel()
public String getPath()
public void setPath(String path)
public String getTag()
public void setTag(String tag)
public String getConsumes()
public void setConsumes(String consumes)
public String getProduces()
public void setProduces(String produces)
public String getBindingMode()
public void setBindingMode(String bindingMode)
public List<VerbDefinition> getVerbs()
public RestSecuritiesDefinition getSecurityDefinitions()
public void setSecurityDefinitions(RestSecuritiesDefinition securityDefinitions)
public RestSecuritiesRequirement getSecurityRequirements()
public void setSecurityRequirements(RestSecuritiesRequirement securityRequirements)
public void setVerbs(List<VerbDefinition> verbs)
public String getSkipBindingOnErrorCode()
public void setSkipBindingOnErrorCode(String skipBindingOnErrorCode)
public String getClientRequestValidation()
public void setClientRequestValidation(String clientRequestValidation)
public String getEnableCORS()
public void setEnableCORS(String enableCORS)
public String getApiDocs()
public void setApiDocs(String apiDocs)
public RestDefinition path(String path)
public RestDefinition tag(String tag)
public RestDefinition get()
public RestDefinition get(String uri)
public RestDefinition post()
public RestDefinition post(String uri)
public RestDefinition put()
public RestDefinition put(String uri)
public RestDefinition patch()
public RestDefinition patch(String uri)
public RestDefinition delete()
public RestDefinition delete(String uri)
public RestDefinition head()
public RestDefinition head(String uri)
public RestDefinition verb(String verb)
public RestDefinition verb(String verb, String uri)
public RestDefinition id(String id)
OptionalIdentifiedDefinition
id
in class OptionalIdentifiedDefinition<RestDefinition>
id
- the idpublic RestDefinition deprecated()
public RestDefinition description(String text)
OptionalIdentifiedDefinition
description
in class OptionalIdentifiedDefinition<RestDefinition>
text
- sets the text description, use null to not set a textpublic RestDefinition description(String id, String text, String lang)
OptionalIdentifiedDefinition
description
in class OptionalIdentifiedDefinition<RestDefinition>
id
- sets the id, use null to not set an idtext
- sets the text description, use null to not set a textlang
- sets the language for the description, use null to not set a languagepublic RestDefinition consumes(String mediaType)
public RestOperationParamDefinition param()
public RestDefinition param(RestOperationParamDefinition param)
public RestDefinition params(List<RestOperationParamDefinition> params)
public RestOperationParamDefinition param(VerbDefinition verb)
public RestDefinition responseMessage(RestOperationResponseMsgDefinition msg)
public RestOperationResponseMsgDefinition responseMessage()
public RestOperationResponseMsgDefinition responseMessage(VerbDefinition verb)
public RestDefinition responseMessages(List<RestOperationResponseMsgDefinition> msgs)
public RestSecuritiesDefinition securityDefinitions()
public RestDefinition produces(String mediaType)
public RestDefinition type(Class<?> classType)
public RestDefinition outType(Class<?> classType)
public RestDefinition bindingMode(RestBindingMode mode)
public RestDefinition bindingMode(String mode)
public RestDefinition skipBindingOnErrorCode(boolean skipBindingOnErrorCode)
public RestDefinition clientRequestValidation(boolean clientRequestValidation)
public RestDefinition enableCORS(boolean enableCORS)
public RestDefinition apiDocs(Boolean apiDocs)
public RestDefinition security(String key)
public RestDefinition security(String key, String scopes)
public RestDefinition to(String uri)
route()
instead.uri
- the uri of the endpointpublic RestDefinition toD(String uri)
route()
instead.uri
- the uri of the endpointpublic RouteDefinition route()
public String buildFromUri(VerbDefinition verb)
public List<RouteDefinition> asRouteDefinition(org.apache.camel.CamelContext camelContext)
RouteDefinition
which Camel routing
engine can add and run. This allows us to define REST services using this REST DSL and turn those into regular
Camel routes.camelContext
- The Camel contextprotected void validateUniquePaths()
public static RouteDefinition asRouteApiDefinition(org.apache.camel.CamelContext camelContext, org.apache.camel.spi.RestConfiguration configuration)
RouteDefinition
which Camel routing
engine uses to service the rest api docs.Apache Camel