Skip to main content

ColdFusion 10: Returning Complex data from a REST service

There are various complex types in ColdFusion – Array, Struct, Query. When a REST service in ColdFusion returns one of these complex types, it has to be serialized to either JSON or XML format. As explained in my previous post, the HTTP protocol can be used in content type negotiation. You can specify the desired content type either by specifying it at the end of the URL or in the Accept header of HTTP request. In this post, I’ll explain the format in which the complex types are returned from a ColdFusion REST service.

JSON format:
Consider the following REST service:
<cfcomponent rest="true" restpath="/jsonSerialization" produces="application/JSON"> <cffunction name="structSerialization" access="remote" httpmethod="GET" returntype="Struct" restpath="serializeStruct"> <cfset myStruct = StructNew()> <cfset myStruct.productName = "ColdFusion"> <cfset myStruct.productVersion = 10> <cfset myStruct.codeName = "Zeus"> <cfreturn myStruct> </cffunction> <cffunction name="querySerialization" access="remote" httpmethod="GET" returntype="Query" restpath="serializeQuery"> <cfset myQuery = queryNew("productName,version,codeName", "Varchar,Integer,Varchar", [["ColdFusion", 9, "Centaur"], ["ColdFusion", 10, "Zeus"]])> <cfreturn myQuery> </cffunction> <cffunction name="arraySerialization" access="remote" httpmethod="GET" returntype="Array" restpath="serializeArray"> <cfset myArray = ArrayNew(2)> <cfset ArrayAppend(myArray, ["ColdFusion", 9, "Centaur"])> <cfset ArrayAppend(myArray, ["ColdFusion", 10, "Zeus"])> <cfreturn myArray> </cffunction> <cffunction name="cfcSerialization" access="remote" httpmethod="GET" returntype="TestComponent" restpath="serializeCFC"> <cfset obj = new TestComponent()> <cfset obj.prop1 = "CF"> <cfset obj.prop2 = "Zeus"> <cfreturn obj> </cffunction> </cfcomponent>
As you can see, the produces attribute is specified at the component level and not at the function level. This indicates that all the services in this component produce or return data in the specified format(application/json here). However, if the produces attribute is specified at both component and at the function level then the one specified at the function level would take precedence.
The complex types – Array, Struct, Query as well as a CFC can be serialized to a JSON format. The above REST service is invoked using CFHTTP with the URI: http://localhost:8500/rest/complexTypes/jsonSerialization/serializeQuery.json (to obtain query data) and then the result is de-serialized to obtain the below output:
Query_Serialized_JSON
The above struct contains the query data as well as the columns.

XML format:
Similar to the JSON format, if the produces attributes’ value is changed to application/XML then the complex data returned from a REST service is serialized to XML format. Here is the output obtained by invoking the REST service to obtain the CFC data serialized to XML format:

<COMPONENT ID="1" NAME="restapp.ComplexTypes.TestComponent">
<PROPERTY NAME="PROP1" TYPE="STRING">CF</PROPERTY>
<PROPERTY NAME="PROP2" TYPE="STRING">Zeus</PROPERTY>
</COMPONENT>

Similarly other complex data types can be serialized to JSON or XML format.

Comments

Popular posts from this blog

Adding beforeRender and afterRender functions to a Backbone View

I was working on a Backbone application that updated the DOM when a response was received from the server. In a Backbone View, the initialize method would perform some operations and then call the render method to update the view. This worked fine, however there was scenario where in I wanted to perform some tasks before and after rendering the view. This can be considered as firing an event before and after the function had completed its execution. I found a very simple way to do this with Underscore's wrap method.

De-obfuscating javascript code in Chrome Developer Tools

I had blogged about JavaScript debugging with Chrome Developer Tools  some time back, wherein I have explained how these developer tools can help in debugging javascript code. Today Google Chrome 12 was released and my Chrome browser was updated to this version. As with every release, there have been some improvements made on performance, usability etc,. One feature that stood out for me is the ability to De-obfuscate the javascript code. What is Minification? Minification is the process of removing unnecessary characters such as white spaces, comments, new lines from the source code. These otherwise would be added to make the code more readable. Minifying the source code helps in reducing the file size and thereby reducing the time taken to download the file. This is the reason why most of the popular javascript libraries such as jQuery are minified. A minified jQuery file is of 31 KB in size where as an uncompressed one is about 229 KB. Unfortunately, debugging minified javascript f

On GraphQL and building an application using React Apollo

When I visualize building an application, I would think of using React and Redux on the front-end which talks to a set of RESTful services built with Node and Hapi (or Express). However, over a period of time, I've realized that this approach does not scale well when you add new features to the front-end. For example, consider a page that displays user information along with courses that a user has enrolled in. At a later point, you decide to add a section that displays popular book titles that one can view and purchase. If every entity is considered as a microservice then to get data from three different microservices would require three http  requests to be sent by the front-end app. The performance of the app would degrade with the increase in the number of http requests. I read about GraphQL and knew that it is an ideal way of building an app and I need not look forward to anything else. The GraphQL layer can be viewed as a facade which sits on top of your RESTful services o