Skip to main content

RESTful Example

Here is an example on how you would create a RESTful webservice with the WCF Web programming model. I assume that you know how to write a WCF service and host it in IIS.
In this example I am going to create a service that will say "Hello" plus a string that is passed into the service, further more the service is going to be hosted in IIS.
the following is a WCF service class,
[ServiceContract]

public interface ITest
{
[OperationContract]
[WebGet(UriTemplate="/SayHello/{str}",ResponseFormat= ebMessageFormat.Xml)]
string SayHello(string str);
}
public class TestImpl : ITest

{
public string SayHello(string str) { return "Hello " + str; }
}

SayHello is our service operation. Note that this is a general WCF service with addittion of a [WebGet] attribute on top of our service operation. by using the [WebGet] attribute we mean that the operation is to be invoked with the HTTP GET verb.The next step is to define our .svc file for our service, the content of the .svc file would look like this.
< @ ServiceHost language=c# Debug="true" Service="RestService.TestImpl" Factory="System.ServiceModel.Activation.WebServiceHostFactory" % >

Again this a general .svc file with the exception of having a WebServiceHostFactory specifed as a factory class to create the appopriate webHttpbinding endpoint.
Now all we have to do is host the service in IIS. The binding used to create RESTfull services, the webHttpbinding does not support multiple authentication, therefor make sure to select only one type of authentication for the directory security in IIS.
We are done...you can access you service like this (assuming that your IIS is running local):
http://localhost/RestService/RstSvc.svc/SayHello/ Iron Man
your response would look something like this...

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/%22>Hello Iron Man</string >
If you notice carefully, you would see that the way we sent the request is mapped to our [WebGet] attribute's UriTemplate : [WebGet(UriTemplate="/SayHello/{str})]" where {str} is a place holder for the parameter of the operation. You would also see that the response format is set to xml. ResponseFormat= WebMessageFormat.Xml, so the response will be sent to us in xml.


Comments

Popular posts from this blog

Hosting WCF services on IIS or Windows Services?

There came one of those questions from the client whether to use II7 hosting or windows service hosting for WCF services. I tried recollecting a few points and thought of writing it down. WCF applications can be hosted in 2 main ways - In a Windows service - On IIS 7 and above When WCF was first released, IIS 6 did not support hosting WCF applications that support Non-HTTP communication like Net.TCP or Net.MSMQ and developers had to rely on hosting these services on Windows Services. With the release of IIS 7, it was possible to deploy these Non-Http based applications also on IIS 7. Following are the benefits of using IIS 7 to host WCF applications Less development effort Hosting on Windows service, mandates the creating of a Windows service installer project on windows service and writing code to instantiate the service, whereas the service could just be hosted on IIS by creating an application on IIS, no further development is needed, just the service implementa...

The maximum nametable character count quota (16384) has been exceeded

Some of our services were growing and the other day it hit the quote, I could not update the service references, nor was I able to run the WCFTest client. An error is diplayed saying " The maximum nametable character count quota (16384) has been exceeded " The problem was with the mex endpoint, where the XML that was sent was too much for the client to handle, this can be fixed by do the following. Just paste the lines below within the configuration section of the devenve.exe.config and the svcutil.exe.config files found at the locations C:\Program Files\Microsoft Visual Studio 9.0\Common7\IDE , C:\Program Files\Microsoft SDKs\Windows\v6.0A\bin Restart IIS and you are done. The detailed error that you get is the following : Error: Cannot obtain Metadata from net.tcp://localhost:8731/ Services/SecurityManager/mex If this is a Windows (R) Communication Foundation service to which you have access, please check that you have enabled metadata publishing at the specified address. F...

Task based Asynchronous pattern, Async & Await and .NET 4.5

One of the key features in .Net 4.5 is to write asynchronous programs much easier. So if I was to write asynchronous programs in .Net 2.0/3.5, I would either follow the event based model or the callback based model. For an example, a synchronous method that does intensive work (say the DoWork()) can be made asynchronous by using the following patterns 1) Implementing the IAsyncResult pattern. in this implementation, 2 methods are exposed for the DoWork() synchronous method, the BeginDoWork() and the EndDoWork() method. The user will call the BeingDoWork() passing in the required parameters and a callback of the delegate type AsyncCallback(IAsyncResult). The BeginDoWork() will spawn a new thread a return control back to the user. Once work is completed in the spawned method, as a last step, it will call the inform the AsyncResult implementation, which in turns will call the EndDoWork() (which is the callback that was passed in to the BeginDoWork()). 2) Implementing the event pattern. ...