Creating WCF Data Service using OData

Hi Friends, 

Today let's talk a bit about OData protocol and how to host a simple WCF data services in IIS 8. 

Open Data Protocol or OData for short is used almost in everywhere in the software industry to exchange data. It is a open standard and many technologies like .net, java, iOS, android, ruby, javascript etc... provide  adequate support for OData exchange. Let's create a simple WCF data service and see how to host it in IIS 8. Follow these simple steps. 

Before that, This is a summary of what we are about to do. 
"We create a simple database with one table, and expose the data using WCF data service to clients as XML or Json. The service is then be hosted in IIS 8 "  
This is a Notification Service which will push daily notifications upon user requests. Once a user request with the date, it will send the related notification to the user. Very simple service!! Let's get started..

Step 01

First off, we need to create a database. Go to your SQL Server Management studio and create a new database called "NotificationDb" with one table named "Notifications". 
Fig1: Database Structure

Fig2: Table Design View


Have your 'Id' column auto increment by setting Is Identity = "Yes" down in the column properties.
Let's populate the table with few rows.

Fig3: Sample Data for Notification Table

Alright, now that you are done with the database stuff, switch over to Visual Studio 2010/2012 and let's write some code.

Step 02

Go to File > New > Web Site.. and select ASP.NET Empty Web Site. Name your web site as "NotificationSite".
Figure 05. Adding Entity Data Model
Figure 04. Create an Empty ASP.NET web application



Ok. Now we got our "NotificationSite". Right click on the NotificationSite and select "Add Item". Then it will pop out. Fig5. You just have to select "ADO.NET Entity Data Model". Click Next. Then you will be asked permission to create App.Config file. App.Config file will be created
Figure 06
on App_Code folder. Then Choose "Generate From Database"(figure 07), provide a database model name (here i used "NotificationDataModel"), Continue with the wizard. Choose your correct database, then select the "Notification" table and click finish.

Once you have successfully done it, VS will show you a graphical representation of the table. Now click save and open "NotificationDataModel.Designer.cs" file in the App_Code folder.
Figure 07












The name of the first public partial class will be  our data context which we will use to interact with database with our WCF data service. Alright, let's now create our service. 

Figure 08

Right click on the website, go to Add New Items, and from the window, select "WCF Data Service".
Provide a suitable name, ex: "NotificationDataService" and click Ok. 

Now we have already built our service. Finally set configurations as in figure 09. Here we have granted read permission to all the all the tables in the database(in our case, we have just single table) and we have defined an access rule, "GetNotifications" which will return notification for the requested Year-Month-Day. Below, we have defined the method body for the GetNotifcations method.
Figure 09

Okay. now we have finally finished :) Right click on the  NotificationDataService.svc file and select "Set As Start Page". Now build and run. Now you can pass parameters and request data from via url. Check out the following example request.


You will receive something similar to figure10 as the response. 
Figure 10

It is very simple to expose data via OData. Hope you guys got the idea ;-) 
Cheers! 



Comments

Post a Comment

Popular posts from this blog

Dependency Injection in ASP.NET MVC 5 with StructureMap

Dependency Injection(DI) is a design pattern that let you write loosely coupled testable code. Typically your classes depend on other classes. Take a look at the following example. The above example shows the " HomeController " of an asp.net mvc application. Within the index method, you can see that it requires to create an instance of " Student " class to get the full name of a student. It is very clear that the Index method is tightly coupled with the Student class.  This is a disadvantage when it comes to testing HomeController . Suppose that you have other methods, with similar types of class dependencies. So, each time when you test the code, you have to pass an actual instance Student class. This is tedious. You don't have the luxury of passing a fake student class to easily test your controllers.  So how do we decouple the Student class from HomeController? This is where DI comes in handy. You can inject dependencies in several ways. Today i will sho...
Read more

Real-time web with Node.js & Socket.io

Image
If you are a .net developer, you may be familiar with ASP.net SignalR for real-time web development. It's one of the coolest libraries for ASP.net that allows bi-directional communication between a server and a client. For more details refer  http://www.asp.net/signalr .  This blog post is an intro to use Node.js and Socket.io to achieve real-time web communication with pure JavaScript using a simple chat program example. Socket.io is a library that makes our lives easy to work with web sockets. Of course, in the Javascript world, there are hundred other libraries available to implement web sockets,  examples .  But i like the simplicity of Socket.io.  Step 01 : Setting up Node.js Depending on the operating system you are using, download Node.js from the official site  here . Installation process of both Windows and OSX is pretty much the same. Double click the setup file and follow the straightforward instruction. For...
Read more

First Look at AngularJS 2.0

Image
AngularJS 2.0 developer preview has been released! This blog post is to experience the new features in the framework with a simple angular2 application. Heads Up : AngularJS 2.0 is written in TypeScript. TypeScript is a super-set of ES6 which is a super-set of ES5 which is currently the browsers fully supported version of JavaScript.  So when writing angular2 components, we can use choose among TypeScript, ES6, ES5 or Dart if you will. For this blog post I use TypeScript. Please refer  5 Min Quick Start Guide  to setup angular2 development environment. Once you have setup the environment and followed the guide, you will be able to see a similar result as follows. Now let's add few more features to this. We will create a shopping list where a user can view the list, add a new item or remove a item from the list. So to begin, let's create the listItems array. Change the app.ts file as follows. Let's create the list.html file which is the view for this...
Read more