DZone
Thanks for visiting DZone today,
Edit Profile
  • Manage Email Subscriptions
  • How to Post to DZone
  • Article Submission Guidelines
Sign Out View Profile
  • Post an Article
  • Manage My Drafts
Over 2 million developers have joined DZone.
Log In / Join
Refcards Trend Reports Events Over 2 million developers have joined DZone. Join Today! Thanks for visiting DZone today,
Edit Profile Manage Email Subscriptions Moderation Admin Console How to Post to DZone Article Submission Guidelines
View Profile
Sign Out
Refcards
Trend Reports
Events
Zones
Culture and Methodologies Agile Career Development Methodologies Team Management
Data Engineering AI/ML Big Data Data Databases IoT
Software Design and Architecture Cloud Architecture Containers Integration Microservices Performance Security
Coding Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks
Partner Zones AWS Cloud
by AWS Developer Relations
Culture and Methodologies
Agile Career Development Methodologies Team Management
Data Engineering
AI/ML Big Data Data Databases IoT
Software Design and Architecture
Cloud Architecture Containers Integration Microservices Performance Security
Coding
Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance
Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks
Partner Zones
AWS Cloud
by AWS Developer Relations
Building Scalable Real-Time Apps with AstraDB and Vaadin
Register Now

Trending

  • Front-End: Cache Strategies You Should Know
  • What Is Envoy Proxy?
  • 13 Impressive Ways To Improve the Developer’s Experience by Using AI
  • Application Architecture Design Principles

Trending

  • Front-End: Cache Strategies You Should Know
  • What Is Envoy Proxy?
  • 13 Impressive Ways To Improve the Developer’s Experience by Using AI
  • Application Architecture Design Principles
  1. DZone
  2. Data Engineering
  3. Databases
  4. Mule API: Experience, Process, System

Mule API: Experience, Process, System

This article explains how to define and understand the basic API layers in Mule.

Ankur Bhuyan user avatar by
Ankur Bhuyan
·
Updated Feb. 13, 19 · Tutorial
Like (10)
Save
Tweet
Share
52.35K Views

Join the DZone community and get the full member experience.

Join For Free

This article explains how to define and understand the basic API layers in Mule. I have prepared this demo to explain the layer differences and their implementations. This example is mainly for beginners.

The purpose of this tutorial is to process a valid CSV file and store it into a database. The Experience API lets you expose the API to the end user. The Process API lets you validate the file extension as .csv or not. A system API will carry out the system level processes, such as validating the file contents and processing them to the database.

API Projects Definitions

Image title

Experience API

The Experience API is defined to expose the end user to the API. So, we should define and implement the high-level logic in the API. The purpose of this API is to interact with the Process API and process the output to the end user with the process status.

Step 1: Define the global definitions for the http connectors in the "csv-export-domain" project. 

csv-export-domain.xml

Step 2: Define the RAML definition for the Experience API.

Image title

Image title

Step 3: To generate the flow, right-click on the api.raml file and choose "Mule -> Generate Flows from REST API."

Step 4: Once the api.xml generates the call, see the Process API flow.

Image title

Step 5: Define "initiate-process-api-call" flow for the Process API call. Here is the xml view of the flow.

Image title

Process API

In the Process API, we are doing file extension validation. Except for the .csv file, this API will not process any files. Once the validation is successful, extract the contents of the CSV file and send them to the System API for further processing.

Step 6: Define the RAML definition for the Process API.

Image title

Image title

Step 7: Repeat step 3 and call the System API call.

Image title

Step 8: Define the "initiate-system-api-call" flow for the Process API call. Here is the xml view of the flow. 

Image title

Image title

System API

The System API is for low-level processes. Once we get the JSON input from the Process API, we will validate the content one by one with the Mule validator. If any validation fails, the API will get the actual reason for the validation and reject the flow and pass the reason to the Experience API through the Process API. If the validation of all the content succeeds, process the data for the database to insert/update the record.

Step 9: Define the RAML definition for the System API.

Image title

Step 7: Repeat step 3 and call the "process-file" flow of the System API for content validation and store it into the database (the database part is not complete here).

Image title

Image title

CustomValidationException.java: This custom exception class lets you catch the exception thrown by the validator flow.

Image title

Sample CSV File

Valid content:

Image title

Invalid Content:

Image title

Let me know your thoughts in the comments.

API

Opinions expressed by DZone contributors are their own.

Trending

  • Front-End: Cache Strategies You Should Know
  • What Is Envoy Proxy?
  • 13 Impressive Ways To Improve the Developer’s Experience by Using AI
  • Application Architecture Design Principles

Comments

Partner Resources

X

ABOUT US

  • About DZone
  • Send feedback
  • Careers
  • Sitemap

ADVERTISE

  • Advertise with DZone

CONTRIBUTE ON DZONE

  • Article Submission Guidelines
  • Become a Contributor
  • Visit the Writers' Zone

LEGAL

  • Terms of Service
  • Privacy Policy

CONTACT US

  • 600 Park Offices Drive
  • Suite 300
  • Durham, NC 27709
  • support@dzone.com

Let's be friends: