When i developed a WCF service in VS2010, i was really struggling modifying the web.config file. One of the feature of VS 2010 is the clean web.config or app.config. But in general we don’t pay too much attention to the code that is being generated by the visual studio.
So in VS 2008, it would be pretty simple to update the config file as we can see the existing service entries and use that code as a reference for our new entry. In order to call WCF service from JQuery, we need to make certain changes to web.config file and i could not find any example of updating the clean web.config file of VS2010.
So when i finally figured out how to update the clean CONFIG file, i thought it would be good idea to share for someone who are new to JQUERY and WCF.
Service Set up
1. First create a new WCF Service website
2. Since my service will return data in JSON format, we need to make following changes in your contract.
1: [ServiceContract]
2: public interface IService
3: { 4:
5: [OperationContract]
6: [WebInvoke(Method = "POST",
7: BodyStyle = WebMessageBodyStyle.Wrapped,
8: RequestFormat = WebMessageFormat.Json,
9: ResponseFormat = WebMessageFormat.Json)]
10: string GetData(string input);
11:
12:
13: // TODO: Add your service operations here
14: }
3. Next we need to add the AspNetCompatibilityRequired attribute at class level. This class is a part of System.ServiceModel.Activation namespace.
1: [AspNetCompatibilityRequirements(RequirementsMode = AspNetCompatibilityRequirementsMode.Allowed)]
2: public class Service : IService
3: { 4: public string GetData(string input)
5: { 6: return string.Format("You entered: {0}", input); 7: }
8:
9:
10: }
4. When we create the WCF service in VS 2010, visual studio generates a clean config file. We need to update the web.config file. We need to add a new endpoint in order to allow JQuery communication. endpoint MUST be exposed using WebHttpBinding as this is the only type of binding that supports the transfer of JSON to and from JQuery. We also need to add the </webHttp> behavior on the endpoint.
our new web.config will resemble the following:
1: <?xml version="1.0"?>
2: <configuration>
3:
4: <system.web>
5: <compilation debug="false" targetFramework="4.0" />
6: </system.web>
7: <system.serviceModel>
8: <services>
9: <service behaviorConfiguration="JSonServiceBehavior" name="Service">
10: <endpoint address="" binding="webHttpBinding" behaviorConfiguration="JsonBehavior" contract="IService">
11: <identity>
12: <dns value="localhost"/>
13: </identity>
14: </endpoint>
15: </service>
16:
17: </services>
18: <behaviors>
19: <serviceBehaviors>
20: <behavior>
21: <!-- To avoid disclosing metadata information, set the value below to false and remove the metadata endpoint above before deployment -->
22: <serviceMetadata httpGetEnabled="true"/>
23: <!-- To receive exception details in faults for debugging purposes, set the value below to true. Set to false before deployment to avoid disclosing exception information -->
24: <serviceDebug includeExceptionDetailInFaults="false"/>
25: </behavior>
26:
27: <behavior name="JSonServiceBehavior">
28: <serviceMetadata httpGetEnabled="true"/>
29: <serviceDebug includeExceptionDetailInFaults="false"/>
30: </behavior>
31:
32: </serviceBehaviors>
33: <endpointBehaviors>
34: <behavior name="JsonBehavior">
35: <webHttp/>
36: </behavior>
37: </endpointBehaviors>
38: </behaviors>
39: <serviceHostingEnvironment multipleSiteBindingsEnabled="true" />
40: </system.serviceModel>
41: <system.webServer>
42: <modules runAllManagedModulesForAllRequests="true"/>
43: </system.webServer>
44:
45: </configuration>
1. Add a new ASP.Net web site in the same Service solution, we’ll name it as
WebSite. (new ASP.Net project template is very cool and it creates Master page and the general layout of the web site. Its a pretty cool even for making a sample application)
2. Just a button (either server side or plain HTML button) on the default.aspx page and add a Javascript function to make an AJAX call to our service that we’ve just created.
1: <script language="javascript" type="text/javascript">
2:
3: function GetDataFromService() { 4:
5: var Url = "http://localhost/DataService/Service.svc/GetData";
6: var Parameter = '{"input" :"My Jquery Test"}'; 7: $.ajax({ 8: type: "POST",
9: contentType: "application/json; charset=utf-8",
10: url: Url,
11: data: Parameter,
12: dataType: "json",
13: success: function (response) { 14:
15: alert(response.GetDataResult);
16: },
17: error: function (message) { 18: alert(message);
19: }
20: });
21: return false;
22: }
23: </script>
3. We can invoke the Service methods by passing the method name in parameter.
4. Input parameter will also be passed as JSON string.
5. The result will be returned as <methodname>Result from WCF call.
