WCF Service with SOAP, REST JSON & REST XML – 3 in 1 !
WCF has evolved a lot in the past few years. Currently expectations from end user are that, they should be able to use applications across multiple devices, be it Windows, Mac, mobile devices or web.
Service Oriented Architecture (SOA) is the right architecture when we have to deal with such a scenario. SOA helps multiple type of applications to consume and process data without the need to implement the back-end data access or business logics. Be it a Windows/OS-X desktops application or iOS/Android/Windows mobile applications.
In the case of Windows/ASP.NET web applications, web-service can expose SOAP based service which can be consumed and implemented easily using existing .NET frameworks.
For Mac applications REST as well SOAP can be consumed. Though SOAP consumption requires non traditional methods. With development tools like Xamarin it’s even easier.
For Mobile applications be it iOS based or Android based or Windows Mobile based or even Java based, they can consume REST based service in JSON/XML format and can be implemented easily.
Finally for web based applications we have Jquery which has direct support for JSON.
This post will explain how to enable all the three SOAP, REST JSON & REST XML in WCF Service along with a sample source code.
Let’s start by creating a WCF Service Application using Visual Studio and .NET Framework 4.5. You can use even Framework 4.0 or 3.5
Interface
Let’s modify interface so that operation contracts support REST Get and POST operations
- Set Attributes for each OperationContract (System.ServiceModel.Web.WebInvoke or System.ServiceModel.Web.WebGet) along with URI Template
[OperationContract]
[WebGet(UriTemplate = "/GetData/?value={value}")]//1. Added "WebGet" Attributes
string GetData(int value);
- For WebInvoke set Attribute with Method, UriTemplate & BodyStyle as Bare
[OperationContract]
[WebInvoke(Method = "POST", UriTemplate = "/GetDataUsingDataContract/", BodyStyle = WebMessageBodyStyle.Bare)]//2. Added "WebInvoke" Attribute with Method, UriTemplate & BodyStyle as Bare
CompositeType GetDataUsingDataContract(CompositeType composite);
Setting BodyStyle as Bare will allow the service to expect and respond with data type (json/xml) based on the “content-type: application/json or content-type: application/xml” which should be set as part of incoming request’s header.
Final Interface Code (Look into the highlighted lines)
using System;
using System.Collections.Generic;
using System.Linq;
using System.Runtime.Serialization;
using System.ServiceModel;
using System.ServiceModel.Web;
using System.Text;
namespace MixedWebService
{
// NOTE: You can use the "Rename" command on the "Refactor" menu to change the interface name "IService1" in both code and config file together.
[ServiceContract]
public interface ITestService
{
[OperationContract]
[WebGet(UriTemplate = "/GetData/?value={value}")]//1. Added "WebGet" Attributes
string GetData(int value);
[OperationContract]
[WebInvoke(Method = "POST", UriTemplate = "/GetDataUsingDataContract/", BodyStyle = WebMessageBodyStyle.Bare)]//2. Added "WebInvoke" Attribute with Method, UriTemplate & BodyStyle as Bare
CompositeType GetDataUsingDataContract(CompositeType composite);
// TODO: Add your service operations here
}
// Use a data contract as illustrated in the sample below to add composite types to service operations.
[DataContract]
public class CompositeType
{
bool boolValue = true;
string stringValue = "Hello ";
[DataMember]
public bool BoolValue
{
get { return boolValue; }
set { boolValue = value; }
}
[DataMember]
public string StringValue
{
get { return stringValue; }
set { stringValue = value; }
}
}
}Web.Config
Let’s modify the web.config so that it can support both SOAP as well as REST and allow the service to auto select the REST request and response formats.
For SOAP, add service behavior with name “DefaultServiceBehavior“. This should be under <system.servicemodel><behaviors><serviceBehaviors>
<behavior name="DefaultServiceBehavior">
<serviceMetadata httpGetEnabled="true"/>
<serviceDebug includeExceptionDetailInFaults="true"/>
</behavior>
For REST, add endpoint behavior with name “RESTEndPointBehavior“. This should be under <system.servicemodel><behaviors><endpointBehaviors>
Make sure automaticFormatSelectionEnabled is set to true in webHttp tag. This will allow the service to expect and respond with data type (json/xml) based on the “content-type: application/json or content-type: application/xml” which should be set as part of incoming request’s header.
<behavior name="RESTEndPointBehavior">
<webHttp helpEnabled="true" automaticFormatSelectionEnabled="true"/>
</behavior>
Finally add service under <system.servicemodel><services>
<service name="MixedWebService.TestService" behaviorConfiguration="DefaultServiceBehavior"><!--Added Service with DefaultServiceBehavior as behaviorConfiguration-->
<endpoint address="SoapService" binding="basicHttpBinding" contract="MixedWebService.ITestService"/><!--Added basicHttpBinding as SoapService-->
<endpoint address="RestService" binding="webHttpBinding" behaviorConfiguration="RESTEndPointBehavior" contract="MixedWebService.ITestService"/><!--Added webHttpBinding as RestService with RESTEndPointBehavior as behaviorConfiguration-->
</service>
The endpoint SoapService uses basicHttpBinding where as endpoint RestService uses webHttpBinding.
The RESTEndPointBehavior behavior configuration will make sure the service uses automatic format selection.
Hence when the incoming request’s header has “content-type: application/json”, the service will expect a json based request data and respond with json data. If it has “content-type: application/xml”, the service will expect a xml based request data and respond with xml data.
Final Web.config code (Look into the highlighted lines)
<?xml version="1.0"?>
<configuration>
<appSettings>
<add key="aspnet:UseTaskFriendlySynchronizationContext" value="true" />
</appSettings>
<system.web>
<compilation debug="true" targetFramework="4.5" />
<httpRuntime targetFramework="4.5"/>
</system.web>
<system.serviceModel>
<services>
<service name="MixedWebService.TestService" behaviorConfiguration="DefaultServiceBehavior"><!--Added Service with DefaultServiceBehavior as behaviorConfiguration-->
<endpoint address="SoapService" binding="basicHttpBinding" contract="MixedWebService.ITestService"/><!--Added basicHttpBinding as SoapService-->
<endpoint address="RestService" binding="webHttpBinding" behaviorConfiguration="RESTEndPointBehavior" contract="MixedWebService.ITestService"/><!--Added webHttpBinding as RestService with RESTEndPointBehavior as behaviorConfiguration-->
</service>
</services>
<behaviors>
<serviceBehaviors>
<behavior name="DefaultServiceBehavior"><!--Added DefaultServiceBehavior referenced at service tag above-->
<serviceMetadata httpGetEnabled="true"/>
<serviceDebug includeExceptionDetailInFaults="true"/>
</behavior>
</serviceBehaviors>
<endpointBehaviors>
<behavior name="RESTEndPointBehavior"><!--Added RESTEndPointBehavior referenced at service tag above-->
<webHttp helpEnabled="true" automaticFormatSelectionEnabled="true"/><!--automaticFormatSelectionEnabled when set to true expects input and provides output based on the "content-type: application/json or content-type: application/xml" as part of incoming request's header. -->
</behavior>
</endpointBehaviors>
</behaviors>
<protocolMapping>
<add binding="basicHttpsBinding" scheme="https" />
</protocolMapping>
<serviceHostingEnvironment aspNetCompatibilityEnabled="true" multipleSiteBindingsEnabled="true" />
</system.serviceModel>
<system.webServer>
<modules runAllManagedModulesForAllRequests="true"/>
<directoryBrowse enabled="true"/>
</system.webServer>
</configuration>Now let’s look into the part where the hosted service can be consumed and see if it works fine.
SOAP:
Launch the WCF Test Client using Visual Studio Command Prompt
Add the service and call each methods with appropriate inputs. You should be able to see a result similar to below.
For REST we will use Fiddler to compose and analyze the request and response.
Launch the fiddler, use the screenshots below to compose a request. Make a note that content-type header decides the message format.
Also the URL should end with “RestService” then operation
e.g http://localhost:5469/TestService.svc/RestService/GetData/?value=1
REST GET using XML:
REST POST using XML:
REST GET using JSON:
REST POST using JSON:
Note: In all the above scenarios, the input and output use the same data format.
