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

How to use the APP_INITIALIZER token to hook into the Angular bootstrap process

I've been building applications using Angular as a framework of choice for more than a year and this post is not about another React vs Angular or the quirks of each framework. Honestly, I like Angular and every day I discover something new which makes development easier and makes me look like a guy who built something very complex in a matter of hours which would've taken a long time to put the correct architecture in place if I had chosen a different framework. The first thing that I learned in Angular is the use of the APP_INITIALIZER token.

Using MobX to manage application state in a React application

I have been writing applications using React and Redux for quite some time now and thought of trying other state management solutions out there. It's not that I have faced any issues with Redux; however, I wanted to explore other approaches to state management. I recently came across MobX  and thought of giving it a try. The library uses the premise of  `Observables` to tie the application state with the view layer (React). It's also an implementation of the Flux pattern wherein it uses multiple stores to save the application state; each store referring to a particular entity. Redux, on the other hand, uses a single store with top-level state variables referring to various entities.

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...