Ready to get started?

Learn more about the JSON MuleSoft Anypoint Connector or download a free trial:

Download Now

Access JSON Services in Anypoint Using SQL

Create a simple Mule Application that uses HTTP and SQL with the CData Mule Connector for JSON to create a JSON endpoint for JSON services.

The CData Mule Connector for JSON connects JSON services to Mule applications enabling read, write, update, and delete functionality with familiar SQL queries. The Connector allows users to easily create Mule Applications to backup, transform, report, and analyze JSON services.

This article demonstrates how to use the CData Mule Connector for JSON inside of a Mule project to create a Web interface for JSON services. The application created allows you to request JSON services using an HTTP request and have the results returned as JSON. The exact same procedure outlined below can be used with any CData Mule Connector to create a Web interface for the 140+ available data sources.

  1. Create a new Mule Project in Anypoint Studio.
  2. Add an HTTP Connector to the Message Flow.
  3. Configure the address for the HTTP Connector.
  4. Add a CData JSON Connector to the same flow, after the HTTP Connector.
  5. Create a new Connection (or edit an existing one) and configure the properties to connect to JSON (see below). Once the connection is configured, click Test Connection to ensure the connectivity to JSON.

    See the Getting Started chapter in the data provider documentation to authenticate to your data source: The data provider models JSON APIs as bidirectional database tables and JSON files as read-only views (local files, files stored on popular cloud services, and FTP servers). The major authentication schemes are supported, including HTTP Basic, Digest, NTLM, OAuth, and FTP. See the Getting Started chapter in the data provider documentation for authentication guides.

    After setting the URI and providing any authentication values, set DataModel to more closely match the data representation to the structure of your data.

    The DataModel property is the controlling property over how your data is represented into tables and toggles the following basic configurations.

    • Document (default): Model a top-level, document view of your JSON data. The data provider returns nested elements as aggregates of data.
    • FlattenedDocuments: Implicitly join nested documents and their parents into a single table.
    • Relational: Return individual, related tables from hierarchical data. The tables contain a primary key and a foreign key that links to the parent document.

    See the Modeling JSON Data chapter for more information on configuring the relational representation. You will also find the sample data used in the following examples. The data includes entries for people, the cars they own, and various maintenance services performed on those cars.

  6. Configure the CData JSON Connector.
    1. Set the Operation to 'Select with Streaming'.
    2. Set the Query type to Dynamic.
    3. Set the SQL query to SELECT * FROM #[message.inboundProperties.'http.query.params'.get('table')] to parse the URL parameter table and use it as the target of the SELECT query. You can customize the query further by referencing other potential URL parameters.
  7. Add a Transform Message Component to the flow.
    1. Map the Payload from the input to the Map in the output.
    2. Set the Output script to the following to convert the payload to JSON:
      %dw 1.0
      %output application/json
      ---
      payload
              
  8. To view your JSON services, navigate to the address you configured for the HTTP Connector (localhost:8081 by default) and pass a table name as the table URL parameter: http://localhost:8081?table=people
    The people data is available as JSON in your Web browser and any other tools capable of consuming JSON endpoints.

At this point, you have a simple Web interface for working with JSON services (as JSON data) in custom apps and a wide variety of BI, reporting, and ETL tools. Download a free, 30 day trial of the Mule Connector for JSON and see the CData difference in your Mule Applications today.