[转]Web API Introduction to OData Services using ASP.NET Web API
2017-05-27 12:08
591 查看
本文转自:http://mahedee.net/tag/web-api/
What is OData?
OData Stands for Open Data Protocol. It is a data access protocol for the web. OData provides a uniform way to query and manipulate data sets through CRUD operations (create, read, update, and delete). OData consumption can be done across different Programming Language. ASP.NET Web API supports both OData v3 and V4.
Advantages of OData Services
OData based on REST Architecture so we can retrieve data using URL
Support CRUD Operation using HTTP Method like GET, POST, PUT, DELETE
Support HTTP, JSON and Atom Pub
It is very light weight, so interaction of client and server is very fast
Disadvantage
Since it is URL based so many people think it is less secure
It does not support all type of custom query
Let’s implement OData Services using ASP.NET Web API
Tools and Technology used
I used following tools and technology to develop the project –
Visual Studio 2013
Visual C#
ASP.NET Web API 2
Entity Framework 6
Postman(Google postman)
Step 1: Create a ASP.net Web API Project
Open visual studio and then go
File -> Project -> ASP.NET Web Application
Now select Web API and press OK
Step 2: Install Microsoft.AspNet.Odata
To install OData Nuget Pacakge from Package Manager Console.
Select Tool -> NuGet Package Manager > Package Manager Console
Type following command in package manager console
PM> Install-Package Microsoft.AspNet.Odata
Step 3: Create a model name Employee
Create a Model name Employee in model folder
?
Step 4: Change or Add Connection String
Change or Add connection string in Web.config
?
Step 5: Create a Context class
?
Step 6: Add a Controller
Press right button on Controller folder -> Add -> Controller
Now choose “Web API 2 OData v3 Controller with actions, using Entity Framework” scaffolding template and then press Add.
Now choose Controller Name as EmployeeController, Model name as Employee and Context name as HRMContext and click Add like below.
The following code will be generated on corresponding for the controller.
?
Step 7: Configure OData End Point
Open the file App_Start/WebApiConfig.cs. Add the following using statements:
using System.Web.Http.OData.Builder;
using System.Web.Http.OData.Extensions;
using Web.OData.Models;
Add the following code in the register method.
?
Step 8: Enable Migration
Type the following command in package manager console to enable migration
PM> Enable-Migrations -ContextTypeName HRMContext
After pressing enter you will see a class name Configuration is created in Mingrations folder with some codes.
Step 9: Add seed data and add migration
Modify the Seed() method of Configuration class like below to add some seed data.
?
Now type the following command in the package manager console to add a migration.
PM> Add-Migration initialmigration
Step 10: Update database and attaché mdf file
Now type the following command in package manager console.
PM> Update-Database –Verbose
You will see two file .mdf and .ldf is created in your App_data directory. Now attached the file like below.
Now run you application. Run Postman. Type http://localhost:64126/odata/Employee in your postbox you will see following output in JSON format. Use port number on which your application currently running instead of 64126.
Now, it’s working…!! Cheers!!!
Download Source Code
What is OData?
OData Stands for Open Data Protocol. It is a data access protocol for the web. OData provides a uniform way to query and manipulate data sets through CRUD operations (create, read, update, and delete). OData consumption can be done across different Programming Language. ASP.NET Web API supports both OData v3 and V4.
Advantages of OData Services
OData based on REST Architecture so we can retrieve data using URL
Support CRUD Operation using HTTP Method like GET, POST, PUT, DELETE
Support HTTP, JSON and Atom Pub
It is very light weight, so interaction of client and server is very fast
Disadvantage
Since it is URL based so many people think it is less secure
It does not support all type of custom query
Let’s implement OData Services using ASP.NET Web API
Tools and Technology used
I used following tools and technology to develop the project –
Visual Studio 2013
Visual C#
ASP.NET Web API 2
Entity Framework 6
Postman(Google postman)
Step 1: Create a ASP.net Web API Project
Open visual studio and then go
File -> Project -> ASP.NET Web Application
Now select Web API and press OK
Step 2: Install Microsoft.AspNet.Odata
To install OData Nuget Pacakge from Package Manager Console.
Select Tool -> NuGet Package Manager > Package Manager Console
Type following command in package manager console
PM> Install-Package Microsoft.AspNet.Odata
Step 3: Create a model name Employee
Create a Model name Employee in model folder
?
Change or Add connection string in Web.config
?
?
Press right button on Controller folder -> Add -> Controller
Now choose “Web API 2 OData v3 Controller with actions, using Entity Framework” scaffolding template and then press Add.
Now choose Controller Name as EmployeeController, Model name as Employee and Context name as HRMContext and click Add like below.
The following code will be generated on corresponding for the controller.
?
Open the file App_Start/WebApiConfig.cs. Add the following using statements:
using System.Web.Http.OData.Builder;
using System.Web.Http.OData.Extensions;
using Web.OData.Models;
Add the following code in the register method.
?
Type the following command in package manager console to enable migration
PM> Enable-Migrations -ContextTypeName HRMContext
After pressing enter you will see a class name Configuration is created in Mingrations folder with some codes.
Step 9: Add seed data and add migration
Modify the Seed() method of Configuration class like below to add some seed data.
?
PM> Add-Migration initialmigration
Step 10: Update database and attaché mdf file
Now type the following command in package manager console.
PM> Update-Database –Verbose
You will see two file .mdf and .ldf is created in your App_data directory. Now attached the file like below.
Now run you application. Run Postman. Type http://localhost:64126/odata/Employee in your postbox you will see following output in JSON format. Use port number on which your application currently running instead of 64126.
Now, it’s working…!! Cheers!!!
Download Source Code
相关文章推荐
- An Introduction to ASP.NET Web API
- Introduction to ASP.NET Web API
- How do I get ASP.NET Web API to return JSON instead of XML using Chrome
- Introduction to ASP.NET Web Programming Using the Razor Syntax (C#)
- Introduction to the ASP.NET Web API
- Using jQuery to Consume ASP.NET JSON Web Services
- How to generate an RSS feed for your web site using ASP.NET
- 转:ASP.NET Web Services or .NET Remoting: How to Choose
- How to Migrate from WCF Web API to ASP.NET Web API
- Creating a REST service using ASP.NET Web API
- Building a Web Application->Introduction to ASP.NET Pages
- How to pass javascript complex object to ASP.NET Web Api and MVC
- Introduction to ASP.NET and Web Forms
- Introduction to using Java Persistence API in a web application in Java EE environment
- HOW TO Set Up Multi-Server ASP.NET Web Applications and Web Services
- 主攻ASP.NET MVC4.0之重生:Asp.Net MVC WebApi OData
- Using ASP.NET Web API with ASP.NET Web Forms
- New Introduction to ASP.NET 2.0 Web Parts Framework
- basic-http-authentication-in-asp-net-web-api-using-message-handlers asp.net mvc4 web api authentication