Over a million developers have joined DZone.
{{announcement.body}}
{{announcement.title}}

Propagate an Error Response in Mule API

DZone's Guide to

Propagate an Error Response in Mule API

Read this tutorial that includes pictures for reference in order to learn more about how to propagate an error response in Mule API.

· Integration Zone ·
Free Resource

The State of API Integration 2018: Get Cloud Elements’ report for the most comprehensive breakdown of the API integration industry’s past, present, and future.

Background

Mule API architecture suggests 3 layers of implementation i.e Experience layer, Process layer, and System layer.

What happens if an error occurs at System layer? You might have observed that whenever a system API throws an error (for example 404), the HTTP call in Process API goes into exception (org.mule.module.http.internal.request.ResponseValidatorException).

If you are using the generic apiKit Global Exception Mapping, it will be handled by 500 and your process API will return "500: Internal server Error: Response code 404 mapped as failure." Moreover, your Experience API will return "500: Internal Server Error: Response code 500 mapped as failure."

The client application that is consuming your experience API will have no clue of what went wrong with the response it received.

Requirement

We wish to propagate the response of system API to Experience API, so the client application consuming the experience API can figure out what exactly went wrong.

Solution

In the process API, the HTTP component that invokes the systems API, configure the "Target" as a flow variable.
Image title

In Exception handling Strategy, a catch exception strategy within a choice exception strategy can be used.

Image title

Set the Execute when: #[exception.causedBy(org.mule.module.http.internal.request.ResponseValidatorException)]

Image title

Set the property HTTP status by trimming the response message available.

Image title

Set the Payload with appropriate response data along with the flow variable saved.

Image title

Repeat the same with Experience API.

Conclusion

If data abstraction is not the requirement and we wish to propagate the error code from underlying APIs to client applications, this process can be used.

Your API is not enough. Learn why (and how) leading SaaS providers are turning their products into platforms with API integration in the ebook, Build Platforms, Not Products from Cloud Elements.

Topics:
mule ,error handling ,api ,integration

Opinions expressed by DZone contributors are their own.

{{ parent.title || parent.header.title}}

{{ parent.tldr }}

{{ parent.urlSource.name }}