APIkit XML Reference

This reference contains dependency, namespace, schema, and other information about APIkit.

APIkit Dependency Information

<dependency>
  <groupId>org.mule.modules</groupId>
  <artifactId>mule-apikit-module</artifactId>
  <version>1.1.0</version>
  <classifier>mule-plugin</classifier>
</dependency>

APIkit Namespace and Schema

xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
xsi:schemaLocation="http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd"

apikit Elements

Element Name Description Required

apikit:config

APIkit configuration

Y

apikit:console

Refers to the config-ref property in the http:listener element in the api-console flow that defines the API Console URL

N

apikit:router

A rest routing message processor nested in the flow element

Y

apikit:config Attributes

These elements are of type NonBlankString.

Attribute Name Required Description

outboundHeadersMapName

N

Used to identify the name of the map the contains response headers

httpStatusVarName

N

The name of the variable that stores the HTTP status code in the response

keepRamlBaseUri

N

An alias for the equivalent "keepApiBaseUri" attribute.

This attribute is deprecated since APIkit 1.2.0 and only kept for compatibility with APIkit 1.1.x.
It’s recommended that API implementations use "keepApiBaseUri" instead of “keepRamlBaseUri”.

name

Y

Configuration name that other elements, such as apikit:router, reference

raml

Y

An alias for the equivalent "api" attribute.

This attribute is deprecated since APIkit 1.2.0 and only kept for compatibility with APIkit 1.1.x.
It’s recommended that API implementations use "api" instead of “raml”.

parser

N

Specifies the parser used to validate requests.

This attribute is valid for APIkit 1.2.0 and later

Possible values are:

  • AUTO: The APIkit Router will try to initiate using AMF, it’s not possible (it has errors), then it will try with the RAML Parser.

  • AMF: The APIkit Router will use AMF to read the API and validate incoming requests.

  • RAML: The APIkit Router will use RAML Parser to read the API and validate incoming requests. This is similar to previous APIkit versions.

Default Value: AUTO.

api

N

Root API file location.

This attribute is valid for APIkit 1.2.0 and later

It can be any of a URL, the relative path to a file located under src/main/resources/api, or the API Sync resource path.

keepApiBaseUrii

N

This attribute is valid for APIkit 1.2.0 and later

When set to false, it rewrites the baseUri in the RAML definition of the API.
If set to true it does not rewrite the baseUri field.

If you are using APIkit behind a reverse proxy, you can use API Console if you set keepRamlBaseUri to true to put the URL of a proxy in the baseUri property.

apikit:router Attributes

Attribute Name Required Description

disableValidations

N

Disables validations of requests.

headerStrictValidation

N

Validates that request headers are defined in RAML file or belong to a well-known set of headers.

queryParamsStrictValidation

N

Validates that request query parameters are defined in RAML file.

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub
Give us your feedback!
We want to build the best documentation experience for you!
Help us improve with your feedback.
Take the survey!