OData 集成

介绍

OData被定义为“允许以简单和标准的方式创建和使用可查询和可互操作的RESTful API的开放协议”。见  odata.org您可以将OData与ASP.NET Boilerplate一起使用。

该  Abp.Web.Api.OData  NuGet包简化了它的使用。

建立

安装NuGet包

我们应该首先将Abp.Web.Api.OData NuGet包安装到我们的WebApi项目中:

Install-Package Abp.Web.Api.OData

设置模块依赖关系

我们应该从我们的模块中设置依赖到AbpWebApiODataModule。例:

[DependsOn(typeof(AbpWebApiODataModule))]
public class MyProjectWebApiModule : AbpModule
{
    ...
}

请参阅  模块系统文档  以了解模块依赖性。

配置您的实体

OData要求您声明可用作OData资源的实体。我们应该在 我们模块PreInitialize方法中执行此操作,如下所示:

[DependsOn(typeof(AbpWebApiODataModule))]
public class MyProjectWebApiModule : AbpModule
{
    public override void PreInitialize()
    {
        var builder = Configuration.Modules.AbpWebApiOData().ODataModelBuilder;

        // Configure your entities here...
        builder.EntitySet<Person>("Persons");
    }

    ...
}

在这里,我们获取ODataModelBuilder引用并设置Person实体。同样,您可以使用EntitySet添加其他实体。请参阅  创建控制器

Abp.Web.Api.OData NuGet包中包含AbpODataEntityController基类(扩展标准ODataController)以轻松创建控制器。

以下是如何为Person实体创建OData端点的示例:

public class PersonsController : AbpODataEntityController<Person>, ITransientDependency 
{
    public PersonsController(IRepository<Person> repository)
        : base(repository)
    {
    }
}

就这么简单。AbpODataEntityController的所有方法都是虚拟的。这意味着您可以覆盖Get,Post,Put,Patch,Delete等操作并添加自己的逻辑。

组态

Abp.Web.Api.OData使用传统配置自动调用HttpConfiguration.MapODataServiceRoute方法。如果需要,可以将Configuration.Modules.AbpWebApiOData()。MapAction设置为自己映射OData路由。

例子

以下是对上面定义的控制器的一些示例请求。假设应用程序适用于  http:// localhost:61842我们将向您展示一些基础知识。由于OData是标准协议,因此您可以在Web上轻松找到更高级的示例。

获取实体列表

让所有人。

请求
GET http://localhost:61842/odata/Persons
响应
{
  "@odata.context":"http://localhost:61842/odata/$metadata#Persons","value":[
    {
      "Name":"Douglas Adams","IsDeleted":false,"DeleterUserId":null,"DeletionTime":null,"LastModificationTime":null,"LastModifierUserId":null,"CreationTime":"2015-11-07T20:12:39.363+03:00","CreatorUserId":null,"Id":1
    },{
      "Name":"John Nash","IsDeleted":false,"DeleterUserId":null,"DeletionTime":null,"LastModificationTime":null,"LastModifierUserId":null,"CreationTime":"2015-11-07T20:12:39.363+03:00","CreatorUserId":null,"Id":2
    }
  ]
}

获得单一实体

获得Id = 2的人。

请求
GET http://localhost:61842/odata/Persons(2)
响应
{
  "@odata.context":"http://localhost:61842/odata/$metadata#Persons/$entity","Name":"John Nash","IsDeleted":false,"DeleterUserId":null,"DeletionTime":null,"LastModificationTime":null,"LastModifierUserId":null,"CreationTime":"2015-11-07T20:12:39.363+03:00","CreatorUserId":null,"Id":2
}

使用导航属性获取单个实体

让Id = 1的人包括他的电话号码。

请求
GET http://localhost:61842/odata/Persons(1)?$expand=Phones
响应
{
  "@odata.context":"http://localhost:61842/odata/$metadata#Persons/$entity","Name":"Douglas Adams","IsDeleted":false,"DeleterUserId":null,"DeletionTime":null,"LastModificationTime":null,"LastModifierUserId":null,"CreationTime":"2015-11-07T20:12:39.363+03:00","CreatorUserId":null,"Id":1,"Phones":[
    {
      "PersonId":1,"Type":"Mobile","Number":"4242424242","CreationTime":"2015-11-07T20:12:39.363+03:00","CreatorUserId":null,"Id":1
    },{
      "PersonId":1,"Type":"Mobile","Number":"2424242424","CreationTime":"2015-11-07T20:12:39.363+03:00","CreatorUserId":null,"Id":2
    }
  ]
}

查询

这是一个更高级的查询,包括过滤,排序和获得前2个结果。

请求
GET http://localhost:61842/odata/Persons?$filter=Name eq 'Douglas Adams'&$orderby=CreationTime&$top=2
响应
{
  "@odata.context":"http://localhost:61842/odata/$metadata#Persons","value":[
    {
      "Name":"Douglas Adams","IsDeleted":false,"DeleterUserId":null,"DeletionTime":null,"LastModificationTime":null,"LastModifierUserId":null,"CreationTime":"2015-11-07T20:12:39.363+03:00","CreatorUserId":null,"Id":1
    },{
      "Name":"Douglas Adams","IsDeleted":false,"DeleterUserId":null,"DeletionTime":null,"LastModificationTime":null,"LastModifierUserId":null,"CreationTime":"2016-01-12T20:29:03+02:00","CreatorUserId":null,"Id":3
    }
  ]
}

OData支持分页,排序,过滤,投影等等。有关 更多信息,请参阅  OData文档

创建新实体

在这个例子中,我们正在创建一个新人。

请求
POST http://localhost:61842/odata/Persons

{
    Name: "Galileo Galilei"
}

这里,“Content-Type”标题是“application / json”。

响应
{
  "@odata.context": "http://localhost:61842/odata/$metadata#Persons/$entity",
  "Name": "Galileo Galilei",
  "IsDeleted": false,
  "DeleterUserId": null,
  "DeletionTime": null,
  "LastModificationTime": null,
  "LastModifierUserId": null,
  "CreationTime": "2016-01-12T20:36:04.1628263+02:00",
  "CreatorUserId": null,
  "Id": 4
}

如果我们再次获得列表,我们可以看到新人。我们还可以在OData支持的情况下更新或删除现有实体。

获取MetaData

我们可以获取实体的元数据,如本例所示。

请求
GET http://localhost:61842/odata/$metadata
响应
<?xml version="1.0" encoding="utf-8"?>

<edmx:Edmx Version="4.0" xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx">

    <edmx:DataServices>

        <Schema Namespace="AbpODataDemo.People" xmlns="http://docs.oasis-open.org/odata/ns/edm">

            <EntityType Name="Person">

                <Key>

                    <PropertyRef Name="Id" />

                </Key>

                <Property Name="Name" Type="Edm.String" Nullable="false" />

                <Property Name="IsDeleted" Type="Edm.Boolean" Nullable="false" />

                <Property Name="DeleterUserId" Type="Edm.Int64" />

                <Property Name="DeletionTime" Type="Edm.DateTimeOffset" />

                <Property Name="LastModificationTime" Type="Edm.DateTimeOffset" />

                <Property Name="LastModifierUserId" Type="Edm.Int64" />

                <Property Name="CreationTime" Type="Edm.DateTimeOffset" Nullable="false" />

                <Property Name="CreatorUserId" Type="Edm.Int64" />

                <Property Name="Id" Type="Edm.Int32" Nullable="false" />

                <NavigationProperty Name="Phones" Type="Collection(AbpODataDemo.People.Phone)" />

            </EntityType>

            <EntityType Name="Phone">

                <Key>

                    <PropertyRef Name="Id" />

                </Key>

                <Property Name="PersonId" Type="Edm.Int32" />

                <Property Name="Type" Type="AbpODataDemo.People.PhoneType" Nullable="false" />

                <Property Name="Number" Type="Edm.String" Nullable="false" />

                <Property Name="CreationTime" Type="Edm.DateTimeOffset" Nullable="false" />

                <Property Name="CreatorUserId" Type="Edm.Int64" />

                <Property Name="Id" Type="Edm.Int32" Nullable="false" />

                <NavigationProperty Name="Person" Type="AbpODataDemo.People.Person">

                    <ReferentialConstraint Property="PersonId" ReferencedProperty="Id" />

                </NavigationProperty>

            </EntityType>

            <EnumType Name="PhoneType">

                <Member Name="Unknown" Value="0" />

                <Member Name="Mobile" Value="1" />

                <Member Name="Home" Value="2" />

                <Member Name="Office" Value="3" />

            </EnumType>

        </Schema>

        <Schema Namespace="Default" xmlns="http://docs.oasis-open.org/odata/ns/edm">

            <EntityContainer Name="Container">

                <EntitySet Name="Persons" EntityType="AbpODataDemo.People.Person" />

            </EntityContainer>

        </Schema>

    </edmx:DataServices>

</edmx:Edmx>

元数据用于调查服务。

示例项目

您可以在此处查看示例项目的源代码:https:  //github.com/aspnetboilerplate/sample-odata

nidie.com.cn - 用心与你沟通