Click here to Skip to main content
Click here to Skip to main content

How to create a JSON WCF RESTful Service in 60 seconds

, 10 Mar 2011
Rate this:
Please Sign up or sign in to vote.
How to expose JSON data over a RESTful interface.

WCF makes it very easy to expose JSON data over a RESTful interface, as long as you are aware of a couple of “gotchas” in advance.

This article will explain those to you, so you can focus on your business logic rather than configuration of your WCF services.

We start this example by creating a WCF Service Library project:

new-project

Next we need to add a reference to the System.ServiceModel.Web framework.  Right click on your project file and select Add Reference…

add-reference

As this framework is not part of the .Net Framework 4 Client Profile, Visual Studio kindly informs us that it will update our target Framework to the full version of .Net Framework 4.  Click Yes to accept this change:

target-change

We are now ready to update our code.

Copy and paste the following code into the App.Config file:

<?xml version="1.0"?>
<configuration>
  <system.serviceModel>
	<services>
	  <service name="WcfJsonRestService.Service1">
		<endpoint address="http://localhost:8732/service1" 
				  binding="webHttpBinding" 
				  contract="WcfJsonRestService.IService1"/>
	  </service>
	</services>
	<behaviors>
	  <endpointBehaviors>
		<behavior>
		  <webHttp />
		</behavior>
	  </endpointBehaviors>
	</behaviors>
  </system.serviceModel>
  <startup>
	<supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.0"/>
  </startup>
</configuration>

Notice the binding is set to webHttpBinding as opposed to the normal project template default of wsHttpBinding. 

The other important change is the addition of an endpointBehavior for WebHttp.

These two changes are required to enable JSON over REST for WCF.

Copy and paste the following code into the IService1 file:

using System.ServiceModel;

namespace WcfJsonRestService
{
    [ServiceContract]
    public interface IService1
    {
        [OperationContract]
        Person GetData(string id);
    }
}

Notice we are accepting an “In” parameter for id of datatype string.  For this example we are returning a custom type of Person.

Copy and paste the following code into the Service1.cs file:

using System;
using System.ServiceModel.Web;

namespace WcfJsonRestService
{
    public class Service1 : IService1
    {
        [WebInvoke(Method = "GET", 
                    ResponseFormat = WebMessageFormat.Json, 
                    UriTemplate = "data/{id}")]
        public Person GetData(string id)
        {
            // lookup person with the requested id 
            return new Person()
                       {
                           Id = Convert.ToInt32(id), 
                           Name = "Leo Messi"
                       };
        }
    }

    public class Person
    {
        public int Id { get; set; }
        public string Name { get; set; }
    }
}

The key elements here are the attributes applied to the method.  We are enabling the method to be called over HTTP GET, returning the data in Json format and setting the Uri template to ensure we are using a RESTful interface.

To test your brand new service we will pass in the id value of 10 simply by opening your favourite browser and pasting in the following URL: 

http://localhost:8732/Service1/data/10

json-browser

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

About the Author

StevenHollidge
Software Developer (Senior)
United Kingdom United Kingdom
Developer of .Net Enterprise solutions in the City of London
Follow on   Twitter

Comments and Discussions

 
QuestionUnable to connect PinmemberRiya200327-Mar-14 4:55 
Questionconsultation Pinmemberjhonatan02995-Dec-13 11:39 
GeneralMy vote of 1 Pinmemberbaytu1-Oct-13 23:07 
GeneralMy vote of 1 Pinmemberbaytu1-Oct-13 23:06 
GeneralMy vote of 5 Pinmembercstogian31-Aug-13 1:17 
QuestionHow about POST a json string to the request? Pinmemberfranklinraj11-Jul-13 5:30 
SuggestionAn alternative walkthough.. PinmemberMikeGledhill5-Feb-13 7:06 
GeneralRe: An alternative walkthough.. Pinmemberkevininstructor3-Mar-14 8:31 
GeneralMy vote of 5 PinmemberJoel Ivory Johnson30-Jan-13 4:56 
QuestionPublish it on IIS 7 Pinmemberm.gaber26-Dec-12 3:26 
GeneralMy vote of 4 Pinmemberwesley_jr4018-Dec-12 6:04 
QuestionRemote Restful services are not working Pinmemberbindugadu7-Nov-12 3:18 
Questionmy vote of 3 PinmemberWen Hao4-Nov-12 21:48 
This code will only work in IE if you access the wcf service using jquery.
You have to enable your crossDomainScriptEnabled to true.
GeneralMy vote of 1 PinmemberDmitry Gonchar30-Oct-12 4:47 
Bug[My vote of 2] Great detail; too bad it doesn't work Pinmemberjltik12-Oct-12 10:20 
QuestionSorry it dose not work PinmemberMember 46643481-Oct-12 13:09 
QuestionPerfekt Work! PinmemberMember 20393547-Aug-12 0:46 
QuestionThis article is of zero use. Pinmembermahakam1-Aug-12 6:06 
AnswerRe: This article is of zero use. Pinmemberjim lahey21-Aug-12 4:04 
AnswerRe: This article is of zero use. PinmemberDerek Viljoen13-Sep-12 5:54 
GeneralMy vote of 5 Pinmemberaishar19-May-12 21:41 
GeneralMy vote of 5 PinmemberRob Philpott17-Apr-12 1:16 
GeneralMy vote of 1 PinmemberMember 313671823-Feb-12 18:48 
QuestionCould not get this demo to work outside the debugger PinmemberMember 848605113-Dec-11 10:13 
AnswerRe: Could not get this demo to work outside the debugger PinmemberGeertSchneider18-Jan-12 23:42 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Mobile
Web01 | 2.8.140709.1 | Last Updated 10 Mar 2011
Article Copyright 2011 by StevenHollidge
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid