Asp.Net Web API 2第十七课——Creating an OData Endpoint in ASP.NET Web API 2(OData终结点)

简介: 前言   很久没更新博客了,加上刚过年,现在准备重新开战,继续自己的学习之路。本文已同步到Web API2系列文章中http://www.cnblogs.com/aehyok/p/3446289.html。

前言

  很久没更新博客了,加上刚过年,现在准备重新开战,继续自己的学习之路。本文已同步到Web API2系列文章中http://www.cnblogs.com/aehyok/p/3446289.html

  示例项目下载地址http://pan.baidu.com/s/1sjEWVPN  

  开放数据协议(OData)是Web数据访问协议。OData提供了一种统一的方式来组织数据,查询数据,并通过操纵CRUD操作的数据集(创建,读取,更新和删除)。

  OData同时支持AtomPub(XML)和JSON格式。OData的还定义了一个方法来公开元数据有关的数据。客户端可以使用元数据来发现类型信息和关系的数据集。ASP.NET Web API OData可以很容易的创建OData终结点的数据集。您可以控制​​哪些操作的OData终结点支持。你可以托管多个的OData终结点,沿着非OData终结点。你可以完全的控制你的数据模型,后台业务逻辑和数据层。

  在本教程中,您将创建一个简单的可供客户端可以查询的OData终结点。您还可以创建一个C#客户端的终结点。本教程使用的Visual Studio2013。

创建 Visual Studio 项目

 在本教程中,您将创建支持基本的 CRUD 操作的OData 终结点。该终结点将公开一个单一的资源,一个产品的列表。以后的教程中将会添加更多的功能。

 选择合适的模版进行创建项目

 

并命名为OData,点击确认后,在下一个Asp.Net 项目对话框中选择 Empty的空模版,并在以下对象添加文件夹和核心引用下:进行勾选Web  API。

添加一个实体模型

 一个model就是在应用程序中展现数据的一个对象。在本教程中,我们需要一个展现产品的模型。这个模型对应着我们的OData的实体类型。

在解决方案资源管理器中,右键单击Models文件夹。从上下文菜单中,选择添加然后选择类。

添加相应的文件,并命名为Product。

在Product.cs文件中,添加如下类定义:

    public class Product
    {
        public int ID { get; set; }
        public string Name { get; set; }
        public decimal Price { get; set; }
        public string Category { get; set; }
    }

ID属性为实体键。客户端可以通过ID来查询产品。此字段也是后台数据库中表的主键,之后进行生成项目的步骤。

添加一个OData的控制器

 控制器就是一个处理HTTP请求的类。在OData服务中你为每个实体数据集定义一个独立的控制器。在本教程中我们将创建一个单一的控制器。

在解决方案资源管理器中,右键单击控制器文件夹。选择添加,然后选择控制器.

在添加支架的对话框中,选择一个OData的模版,如下图所示。

 在添加控制器对话框中,命名控制器名称为ProductsController。选择“使用异步控制器操作”。在模型类下拉菜单中选择Product。  

 

然后点击上面的“新建数据上下文”

  

并命名为ProductServiceContext。

然后将可以看到会在项目中添加两个文件:

 

添加EDM和Route

在解决方案资源管理器中,打开App_Start文件夹,然后找到WebApiConfig.cs文件并打开。用下面的代码进行替换之前默认的配置代码。

        public static void Register(HttpConfiguration config)
        {
            ODataConventionModelBuilder builder = new ODataConventionModelBuilder();
            builder.EntitySet<Product>("Products");
            config.Routes.MapODataRoute("odata", "odata", builder.GetEdmModel());
        }

这个代码处理了两个问题:

1、为OData终结点创建一个数据实体模型(EDM)。

2、为OData终结点添加一个路由。

EDM是一个抽象的数据模型。EDM用于创建元数据文件和定义服务的URIs.ODataConventionModelBuilder 通过使用一组默认的EDM命名约定来创建 EDM。这种方法需要最少的代码。如果你想更多的来控制EDM,使用ODataModelBuilder类明确的添加属性、键、导航属性来创建EDM。

这个EntitySet 方法就是将一个实体添加到EDM实体中。

modelBuilder.EntitySet<Product>("Products");

字符串Products定义的是这个实体集的名称。控制器的名称必须匹配实体集的名称。在这个教程中,这个实体集的名称被命名为”Products“,这个控制器被命名为ProductsController。如果你命名这个实体集为”ProductSet“,那么你将需要把控制器命名为”ProductSetController“。请注意一个终结点可以包含多个实体集。为每个实体集调用EntitySet<T>,然后定义一个合适的控制器。

MapODataRoute 方法为OData终结点添加一个路由。

config.Routes.MapODataRoute("ODataRoute", "odata", model);

第一个参数是一个路由的名称。你的服务的客户端看不到这个名称的。第二个参数是终结点URL的前缀。鉴于这些代码,针对产品实体集的URL是http://hostname/odata/Products。你的应用程序可能会有超过一个的OData终结点。对于每一个终结点,调用MapODataRoute 方法,提供一个唯一的路由名称和一个唯一的URL前缀。

Seed the Database (可选的)

  在这一步骤中,您将使用EF框架来插入数据库中一些测试数据。这一步是可选的,但是它能让你立刻测试出OData终结点。

从工具菜单中找到如下

 

 

并键入如下命名:

Enable-Migrations

这将添加一个Migrations 的文件夹,并有一个Configuration.cs的文件

 

打开Configuration.cs,在Seed方法中添加如下的代码:

        protected override void Seed(OData.Models.ProductServiceContext context)
        {
            context.Products.AddOrUpdate(new Product[] {
                new Product() { ID = 1, Name = "Hat", Price = 15, Category = "Apparel" },
                new Product() { ID = 2, Name = "Socks", Price = 5, Category = "Apparel" },
                new Product() { ID = 3, Name = "Scarf", Price = 12, Category = "Apparel" },
                new Product() { ID = 4, Name = "Yo-yo", Price = 4.95M, Category = "Toys" },
                new Product() { ID = 5, Name = "Puzzle", Price = 8, Category = "Toys" },
            });
        }

然后再在软件包管理器控制台窗口,输入以下命令,并顺序执行两个命令:

Add-Migration Initial
Update-Database

测试OData终结点

 在这一部分,我们将使用 Fiddler Web Debugging 来发送请求到终结点来检测响应消息。这将帮助您去理解OData终结点的功能。

在Visual Studio中,按F5进行运行程序。

 

1、然后在Fiddler中http://localhost:3629/Odata/Products,获得产品列表

点击执行

 

2、为了得到元数据文件,可以发送请求如下http://localhost:3629/odata/$metadata,直接通过浏览器

 

3、为了通过ID来获取某一个实体http://localhost:3629/Odata/Products(1)

4、可以发现默认得到的数据格式是JSON格式的,下面我们来设置一个xml格式的。

得到如下数据

 

5、再换一个数据格式application/json;odata=verbose

得到数据如下

总结

这是执行程序调用上下文之后产生的数据库文件。直接生成在项目中,进行添加即可。

示例项目下载地址http://pan.baidu.com/s/1sjEWVPN

本文参考地址http://www.asp.net/web-api/overview/odata-support-in-aspnet-web-api/creating-an-odata-endpoint

目录
相关文章
|
1天前
|
前端开发 JavaScript API
2024 Web 新特性 - 使用 Popover API 创建弹窗
Popover API简化了Web弹窗创建,标准化处理在所有主要浏览器中可用。它提供声明式创建弹出式菜单、提示和信息卡片,解决代码冗余和兼容性问题。弹窗自动定位在顶层,支持通过Esc键或点击外部关闭,且与触发元素语义关联。基础用法涉及`popover`和`popovertarget`属性。
8 0
|
6天前
|
SQL 缓存 测试技术
RESTful API设计的最佳实践:构建高效、可维护的Web服务接口
【6月更文挑战第11天】构建高效、可维护的RESTful API涉及多个最佳实践:遵循客户端-服务器架构、无状态性等REST原则;设计时考虑URL结构(动词+宾语,使用标准HTTP方法)、使用HTTP状态码、统一响应格式及错误处理;确保数据安全(HTTPS、认证授权、输入验证);实施版本控制;并提供详细文档和测试用例。这些实践能提升Web服务接口的性能和质量。
|
10天前
|
JSON 前端开发 API
Apache HttpClient调用Spring3 MVC Restful Web API演示
Apache HttpClient调用Spring3 MVC Restful Web API演示
12 1
|
10天前
|
XML JavaScript 前端开发
基于SVG的web页面图形绘制API介绍
基于SVG的web页面图形绘制API介绍
16 4
|
12天前
|
Linux C# C++
【.NET Developer】创建ASP.NET Core Blazor项目并打包为Linux镜像发布到Azure应用服务
本文介绍了如何使用VS2019和.NET框架创建一个Blazor应用,并将其部署到Azure应用服务。首先,Blazor是一个使用C#而非JavaScript构建交互式Web UI的框架,支持共享服务器和客户端应用逻辑,以及与Docker和Azure集成。任务包括创建Blazor项目,配置Dockerfile为Linux容器,本地测试,发布到Azure Container Registry (ACR),然后在Azure App Service for Container上部署。在部署过程中,需确保Docker设置正确,开启ACR的Admin访问权限,并监控镜像拉取和容器启动日志。
|
13天前
|
XML JSON API
RESTful API关键部分组成和构建web应用程序步骤
RESTful API关键部分组成和构建web应用程序步骤
13 0
|
18天前
|
机器学习/深度学习 SQL 人工智能
Web LLM 实验:利用 LLM API 实现命令注入
Web LLM 实验:利用 LLM API 实现命令注入
|
18天前
|
SQL 机器学习/深度学习 人工智能
Web LLM 实验:利用 LLM API 实现 SQL 注入
Web LLM 实验:利用 LLM API 实现 SQL 注入
|
19天前
|
XML API 网络架构
Web Service和Web API理解和使用场景
**Web Service**是一种基于网络、使用SOAP协议和XML的数据封装的重服务,适用于跨平台、跨语言的企业系统集成,尤其在安全性和事务处理严格的场景,如银行系统。而**Web API**是轻量级的HTTP接口,常遵循REST原则,使用JSON格式,适合移动应用、开放平台和微服务间的通信,因其简洁高效。选择哪种取决于项目需求,Web Service适合复杂交互,Web API则流行于现代Web应用。
|
20天前
|
应用服务中间件 API nginx
使用Python和Flask构建RESTful Web API
使用Python和Flask构建RESTful Web API
31 0