Contact Us 1-800-596-4880

Create an OData v2 API

The OData MySQL example shows you how to use an HTTP-based data service to query a MySQL database.


The following software is required to create and use an OData REST API with APIkit:

  • OData Plugin

  • Mule runtime engine 4.1.1 or later

  • Anypoint Studio 7.1.4 or later

Additionally, you must download the OData example entity data model.

Implement an OData v2 API Using the APIkit OData Extension

The following example shows you how to implement an OData-enabled REST API:

  1. In Studio, select File > New > Mule Project.

  2. In the Project Name field, type the name of your Mule project.

  3. Click Finish.

  4. Copy the odata.raml file you downloaded in the prerequisites section to the /src/main/resources/api directory in your project.

  5. In the project explorer, right-click odata.raml and select Mule > Generate OData API from RAML Types.

    Window highlights the full path that was previously mentioned to get to the generate OData API from RAML types option.
  6. The OData extension generates the necessary files for your OData API implementation:

    The three files are highlighted in the tree: api.xml in the Mule folder, and api.raml and odatalibrary.raml files in the resource folder.
1 The Mule configuration file with the flows for the API implementation
2 The generated RAML definition
3 The generated RAML libraries
  1. Add the necessary logic for your API implementation in the flows.

OData MySQL Example

The OData MySQL example is a fully functional OData API packaged as a Maven project. In this example, the data source, the app, and the service are local.

First, you install a MySQL database and load tables using a provided script. Next, you import the compressed project into Studio, which includes a MySQL database driver. You can examine the flows to see how to implement the endpoints you need by accessing the data. Then you run the project and call the REST and OData services.

Install and Populate a MySQL Database

  1. Install a MySQL database and launch MySQL.

  2. Download the MySQL project example apikit-odata-example-main.jar.

  3. Run the example.sql script located in src/main/resources using MySQL commands to load data into a database named apikit-odata-example.

Implement the OData API

  1. In Studio, Select File > Import.

  2. Select Anypoint Studio > Packaged mule application (.jar) > Next.

  3. Browse for the apikit-odata-example-main.jar file and click Finish.

  4. In Studio, edit the file inside the src/main/resources folder, and set the following properties to access the local MySQL database:

    ds.db.user=<your MySQL user name><your MySQL host name>
    ds.db.password=<your MySQL password>
  5. Run the API locally by right-clicking the project, and selecting Run As > Mule Application.

You can now access the REST and OData Service.

Access the REST and OData Service

To run the API locally:

  1. Right-click the project, and select Run As > Mule Application.

  2. Access the REST and OData Service using the following URLs:

    • REST API: /api

    • OData API: /api/odata.svc

      The following examples cover a few of the many REST calls and OData queries you can use.

Retrieve a List of Customers

Call the REST API to retrieve the list of customers:


The response is:

  "entries": [
      "ContactName": "Maria Anders",
      "ContactTitle": "Sales Representative",
      "CompanyName": "Alfreds Futterkiste",
      "CustomerID": ""
      "ContactName": "Maria Anders",
      "ContactTitle": "Sales Representative",
      "CompanyName": "Alfreds Futterkiste",
      "CustomerID": "ALFKI"

Access a Description of the OData Service

Get information about the collections behind this service:


The response is:

<service xmlns="" xmlns:atom="" xmlns:app="" xml:base="http://localhost:8081">
    <collection href="customers">
    <collection href="orders">

Get OData Service Metadata

The Service Metadata exposes the structure of OData service resources, its operations, and EDM for a given service.

Get the metadata for HTTP Services:


The response aligns with the odata.raml EDM you used to build the HTTP Services API example:

<edmx:Edmx xmlns:edmx="" Version="1.0">
<edmx:DataServices xmlns:m="" m:DataServiceVersion="2.0">
<Schema xmlns="" Namespace="odata2.namespace">
<EntityType Name="customers">
<PropertyRef Name="CustomerID"/>
<Property Name="CompanyName" Type="Edm.String" Nullable="true" MaxLength="40" Unicode="false"/>
<Property Name="ContactName" Type="Edm.String" Nullable="true" MaxLength="30" Unicode="false"/>
<Property Name="ContactTitle" Type="Edm.String" Nullable="true" MaxLength="30" Unicode="false"/>
<Property Name="CustomerID" Type="Edm.String" Nullable="false" MaxLength="5" Unicode="false"/>
<EntityType Name="orders">
<PropertyRef Name="OrderID"/>
<PropertyRef Name="ShipName"/>
<Property Name="Freight" Type="Edm.Decimal" Nullable="true" Precision="3" Scale="3" Unicode="false"/>

Query the Data Source

Issue OData queries to get the list of customers in XML and JSON format:


Issue an OData query to get the tenth customer in the customer list:


The response is:

    "d": {
        "results": [
                "__metadata": {
                    "uri": "http:/localhost:8081/api/odata.svc/customers('BOTTM')",
                    "type": "odata2.namespace.customers"
                "CompanyName": "Bottom-Dollar Markets",
                "ContactName": "Elizabeth Lincoln",
                "ContactTitle": "Accounting Manager",
                "CustomerID": "BOTTM"
        "__count": "98"

Implement Endpoints for an OData API

You can implement API endpoints such as the get:/customers:config and get:/orders:config flows using Anypoint Studio. The output format of the flows must be JSON. For more information, see the complete functioning example.

Declare Input Variables for a GET

  1. Declare a variable for the APIkit OData Service variable that contains the fields of your entity in a list of strings (List<String>). For example:

    var entityFields = vars.odata.fields
  2. Declare a variable for the APIkit OData Service variable that filters into 'http.query.params'. For example:

    var filters = attributes.queryParams
  3. Declare a variable for the APIkit Odata Service variable that contains the keys of your entity. For example:

    var keys = vars.odata.keyNames
  4. Declare a variable for the APIkit Odata Service variable that contains the table name. For example:

    var remoteEntityName = vars.odata.remoteEntityName

Declare Input Variables for a POST

  1. Declare a variable for the APIkit Odata Service inbound property that contains the entity’s name:

    var remoteEntityName = vars.odata.remoteEntityName
  2. Declare a variable for transforming your payload into something like this: { myKey1: 'myValue1', myKey2: 'myValue2'}.

    var valuesFromPayload = {
      keys: payload pluck $$,
      values: payload pluck "'$'"
  3. Declare two variables, and use joinBy to transform your keys and values into comma-separated-values (CSV). For example:

    var columns = ( (valuesFromPayload.keys map "`$`" ) joinBy ", ") // myKey1, myKey2
    var values = (valuesFromPayload.values joinBy ", ") // 'myValue1', 'myValue2'

Format Output

The output for each flow must conform to the following format:

View on GitHub