ASP.NET Web API 2 OData v4教程

程序数据库格式标准化的开源数据协议

为了增强各种网页应用程序之间的数据兼容性，微软公司启动了一项旨在推广网页程序数据库格式标准化的开源数据协议（OData）计划，于此同时，他们还发 布了一款适用于OData协议的开发工具，以方便网页程序开发者们使用。

Open Data Protocol （开放数据协议，OData）是用来查询和更新数据的一种Web协议，其提供了把存在于应用程序中的数据暴露出来的方式。OData运用且构建于很多 Web技术之上，比如HTTP、Atom Publishing Protocol（AtomPub）和JSON，提供了从各种应用程序、服务和存储库中访问信息的能力。OData被用来从各种数据源中暴露和访问信息， 这些数据源包括但不限于：关系数据库、文件系统、内容管理系统和传统Web站点。

namespace PersonsService.Models
{
    public class Person
    {
        public int Id { get; set; }
        public string Name { get; set; }
        public bool Gender { get; set; }
        public string UserName { get; set; }
    }
}　　

using System.Data.Entity;
namespace PersonsService.Models
{
    public class PersonsContext : DbContext
    {
        public PersonsContext()
    : base("name=PersonsContext")
        {
        }
        public DbSet Persons { get; set; }
    }
}

using Microsoft.OData.Edm;
using PersonsService.Models;
using System.Web.Http;
using System.Web.OData.Builder;
using System.Web.OData.Extensions;
namespace PersonsService
{
    public static class WebApiConfig
    {
        public static void Register(HttpConfiguration config)
        {
            // Web API 配置和服务
            // Web API 路由
            config.MapHttpAttributeRoutes();
            config.Routes.MapHttpRoute(
                name: "DefaultApi",
                routeTemplate: "api/{controller}/{id}",
                defaults: new { id = RouteParameter.Optional }
            );
            //构建路由服务
            config.MapODataServiceRoute(
                routeName: "odata",
                routePrefix: "odata",
                model: GetModel()
                );
        }
        private static IEdmModel GetModel()
        {
            var builder = new ODataConventionModelBuilder();
            var esPerson = builder.EntitySet("Persons");
            return builder.GetEdmModel();
        }
    }
}

using PersonsService.Models;
using System.Linq;
using System.Web.OData;
namespace PersonsService.Controllers
{
    public class PersonsController : ODataController
    {
        private readonly PersonsContext db = new PersonsContext();
        [EnableQuery]
        public IQueryable Get()
        {
            return db.Persons;
        }
        [EnableQuery]
        public IQueryable Get([FromODataUri] int key)
        {
            return db.Persons.Where(r=> r.Id==key);
        }
    }
}

        [HttpPost]
        public IHttpActionResult Post(Person person)
        {
            if (!ModelState.IsValid)
            {
                return BadRequest(ModelState);
            }
            db.Persons.Add(person);
            db.SaveChanges();
            return Created(person);
        }

        [AcceptVerbs("PATCH", "MERGE")]
        public IHttpActionResult Patch([FromODataUri] int key, Delta patch)
        {
            if (!ModelState.IsValid)
            {
                return BadRequest(ModelState);
            }
            Person person = db.Persons.Find(key);
            if (person == null)
            {
                return NotFound();
            }
            patch.Patch(person);
            try
            {
                db.SaveChanges();
            }
            catch (DbUpdateConcurrencyException)
            {
                    throw;
            }
            return Updated(person);
        }

// DELETE: odata/Persons(5)
        public IHttpActionResult Delete([FromODataUri] int key)
        {
            Person person = db.Persons.Find(key);
            if (person == null)
            {
                return NotFound();
            }

            db.Persons.Remove(person);
            db.SaveChanges();

            return StatusCode(HttpStatusCode.NoContent);
        }

        [EnableQuery, HttpGet]
        [ODataRoute("Products({id})/Default.GetCatAndTown")]
        public IHttpActionResult GetCatAndTown([FromODataUri] int id)
        {
            var list = db.Products.Where(r => r.Id == id);
            return Ok(list);
        }