Ben Cull - Payments Engineer and Microsoft Development Professional

5 Lifesaving Tips for Creating a WCF RESTful API in .NET 4


For those of you who haven’t jumped on the bandwagon yet, RESTful Services and APIs are shaping up to be the next big data distribution trend, as they allow a flexible, yet standard way of presenting data and resources to the end user. Better yet, they have less overhead and can be taken advantage of by any system that can use the HTTP protocol.

If you are like me and want to have the best tools at your fingertips as soon as they’ve learned to crawl, you might be using Visual Studio 2010 RC, with .net 4. Whilst .net 4 has given programmers even more power to quickly develop complex systems and web applications, unfortunately there is a lack of social documentation and tutorials while we wait for everyone else to join the party.

Thats why I’ve compiled a list of 5 Lifesaving Tips for Creating a WCF RESTFul API in .NET 4

#1 | Use the WCF Starter Kit

The WCF team have done a great job creating nice new templates that allow you to create a basic RESTful API with almost no configuration. Do yourself a favour and download them now!

Download the WCF REST Starter Kit Preview 2 - This includes the neccessary libraries and template files needed to get going.

A Developer’s Guide to the WCF REST Starter Kit - Contains a lot of great info about some of the features in the WCF REST Starter Kit.

A Guide to Designing and Building RESTful Web Services with WCF 3.5 - Contains a lot of information about how to design and build a WCF Web Service including some excellent reading on the theory of WCF RESTful Services.

#2 | Implement the Automatic Help Pages

This is a great feature of the starter kit, as it allows you to do next to nothing and still get great looking help pages. Just type /help on the end of the uri you wish to implement. It cant be simpler in .net 4, all you need to do is make sure you have the following in your web.config:

  <servicehostingenvironment aspnetcompatibilityenabled="true" />
      <standardendpoint defaultoutgoingresponseformat="Json" helpenabled="true" />

The aptly named helpEnabled property is what allows you to turn on the help pages.

#3 | Use WebServiceHost2Factory and WebProtocolException for Error Handling

A large part of building an API is ensuring there is adequate error handling in place to help the user implement your API. Up until the release of WebServiceHost2Factory, returning the appropriate HTTP response code and message was a chore. Luckily for us we can achieve this feat quickly and easily by utilising the WebServiceHost2Factory and WebProtocoException classes.

First change your Global.asax file to point to the new WebServiceHost2Factory like so:

private void RegisterRoutes()
    RouteTable.Routes.Add(new ServiceRoute(&quot;Authentication&quot;, new WebServiceHost2Factory(), typeof(Authentication)));

I’ve used my Authentication service class as an example, you would replace this with the name of your service class.

Now when we come across an error or exception, we can throw the WebProtocolException and the WebServiceHost2Factory will automatically pick it up and return the appropriate status code and message. Heres an Example:

throw new WebProtocolException(System.Net.HttpStatusCode.BadRequest, "The location parameters provided were incorrect",
    new Error()
       Code = 6001,
       Message = "Please provide either a latitude and longitude, OR a location string which represents an address or landmark."
    }, null);

In this example the user has not given me the correct combination of parameters for this resource, therefore I have set the HTTPStatusCode to BadRequest and also set the status message to “The location parameters provided were incorrect”, to give more meaning to the status. I have also returned a custom .NET object named Error which will automatically be serialized and returned in the response, providing even more information to the user.

#4 | Always Implement Zero Parameter Public Constructors

One of the greatest features of the WCF Web Service updates is the ability to convert between client side XML and JSON, and server side .NET objects seamlessly and more importantly, without the need for DataContracts! However, I have run into a few quirks that can be quite hard to find, one of which was forgetting to add a public zero parameter constructor to any .NET class I want to serialize.

public MyClass() { }

This error is most commonly found in the form of: Type ‘MyType’ cannot be serialized. Consider marking it with the DataContractAttribute attribute, and marking all of its members you want serialized with the DataMemberAttribute attribute. If the type is a collection, consider marking it with the CollectionDataContractAttribute. See the Microsoft .NET Framework documentation for other supported types. Ensure you have a zero parameter public constructor if you receive this error!

#5 | Avoid DateTime.MinValue When Using Json

Probably the hardest quirk to find was the Json serialization bug. Essentially, the default Json Serializer cannot serialize DateTime.MinValue… it just cant. The problem with this bug is that there is no actual error, the response is empty, firebug shows the response as aborted, its just a blank screen. To be safe and to fix any potential Json serialization errors you may be having, just make sure you are using nullable DateTime’s in your serialized classes, like so:

DateTime? myDatetime = null;

Hopefully these tips will inspire you to create a powerful new API for your web application using the latest in WCF RESTful Web Service Technology!

Next post

Using SMTP with Wordpress and IIS

5 Lifesaving Tips for Creating a WCF RESTful API in .NET 4

Get in touch

Send me a message and I'll get back to you.