Community

Cross-origin resource sharing for Bluemix APIs

Share this post:

The IBM Bluemix Platform-as-a-Service (based on Cloud Foundry) naturally supports applications that are composed of many independent services deployed to different hostnames. For each application (which can in turn act as a service API) that you push to Bluemix, the name you provide will be prepended to .mybluemix.net resulting in an address such as:

[code]http://<strong>my-sample-app</strong>.mybluemix.net[/code]

If your cloud-native system of engagement follows the best practices of a microservices architecture you’ll probably have two or more subcomponents (services or APIs) that live on discrete hostnames. What if you have a decoupled JavaScript based front-end that needs to aggregate information from these other Bluemix apps? By default the browser will forbid access to other subdomains.

The solution is to take advantage of the standard HTTP headers that are available to control cross-origin resource sharing (CORS) on the Bluemix services that you wish to provide to JavaScript clients. To illustrate the problem and the solution, consider the simple Ajax application hosted on Bluemix here:

[code]<a href="http://krook-service-consumer.mybluemix.net">http://<strong>krook-service-consumer</strong>.mybluemix.net</a>[/code]

Cross-origin resource sharing for Bluemix APIs proof of concept

If you click the red box, you’ll initiate an asynchronous HTTP call in JavaScript to a servlet on another Bluemix hostname:

[code]<a href="http://krook-service-provider.mybluemix.net/non-cors-provider">http://<strong>krook-service-provider</strong>.mybluemix.net/<strong>non-cors-provider</strong></a>[/code]

The source of this servlet shows that no particular HTTP headers are set, thus the JavaScript client request can never reach it. However, if you click the blue box, you’ll initiate a call to a different servlet on that same Bluemix hostname:

[code]<a href="http://krook-service-provider.mybluemix.net/cors-provider">http://<strong>krook-service-provider</strong>.mybluemix.net/<strong>cors-provider</strong></a>[/code]

This time the Ajax function will successfully consume data from the service, because the HTTP headers set by the service allow JavaScript clients from a different domain to access the servlet. In the example code below, the client application will have access to several read and write methods on the service when requested using asynchronous JavaScript.

[code lang=”java”]
response.setHeader(
"Access-Control-Allow-Origin",
"http://krook-service-consumer.mybluemix.net"
);

response.setHeader(
"Access-Control-Allow-Methods",
"POST, GET, DELETE, PUT"
);

response.setHeader(
"Access-Control-Allow-Headers",
"X-Requested-With, Content-Type"
);
[/code]

This sample illustrates basic use of the CORS headers. Please be sure to consider the security implications when allowing access to certain HTTP methods and client hostnames for your own Bluemix services. For example, if you replace the whitelist of accepted client hostnames with a wildcard “*” any JavaScript client can access your service.

There you have it; a simple way to build applications composed of several microservices on IBM Bluemix and access them from another JavaScript application that is hosted on a different domain (Bluemix or elsewhere). I used Java in this example, but the same standard Cross-origin resource sharing HTTP headers apply whether you’re using Ruby, Node.js, PHP, Python or any other runtime.

More stories
January 18, 2019

IBM Cloud Kubernetes Service Supports containerd

For IBM Cloud Kubernetes Service clusters that run version 1.11 or later, containerd replaces Docker as the container runtime for Kubernetes.

Continue reading

January 18, 2019

Strategies for Building Multi-Region Apps

Enterprises seek to minimize downtime and create resilient architectures to achieve maximum availability. In order to help achieve those goals, we added a new tutorial to our collection of solution tutorials that highlights IBM Cloud's capabilities for building resilient solutions.

Continue reading

January 16, 2019

Deploying Applications on IBM Cloud with Kubernetes and IBM Cloud Databases for PostgreSQL

Deploying a cloud-native application and integrating IBM Cloud Databases is easy using the IBM Cloud Kubernetes Service. In this tutorial, we’ll show you how to set up IBM Cloud Databases for PostgreSQL and deploy a Node.js application using the database with the IBM Cloud Kubernetes Service.

Continue reading