OData v4扩展语法返回错误“ ...在$ expand查询选项中无法使用属性'ProductType'。”

时间:2019-04-01 22:10:45

标签: c# odata

我正在尝试运行一个新的OData V4服务,并且看到意外的错误...

  

“属性'ProductType'不能在$ expand查询中使用   选项。”

我在另一个OData服务中对此没有任何问题,并且我一直在比较两者,但我找不到两个WRT,模型中的项目设置和WebApiConfig之间的显着差异。我是根据create-an-odata-v4-endpoint文章中的示例构建的,而另一个示例是使用脚手架向导创建的。

所以这是表,控制器和WebApiConfig的布局。我还能在哪里寻找未能建立联系的原因?

enter image description here

// Product.cs
public partial class Product
{
    public int ProductId { get; set; }
    public int ProductTypeId { get; set; }
    public string Size { get; set; }
    public string PartNo { get; set; }

    public virtual ProductType ProductType { get; set; }
}

// ProductType.cs
public partial class ProductType{
    [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA2214:DoNotCallOverridableMethodsInConstructors")]    public     ProductType()
    {
        this.Products = new HashSet<Product>();
    }
    public int ProductTypeId { get; set; }
    public string ProductTypeName { get; set; }
    public string Image { get; set; }
    public string ProductDescription { get; set; }
    public string InstallInstructions { get; set; }
    public string DataSheet { get; set; }

    [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly")]
    public virtual ICollection<Product> Products { get; set; }
}

// WebApiConfig.cs
public static void Register(HttpConfiguration config)
{
    // Web API configuration and services

    // Web API routes
    config.MapHttpAttributeRoutes();

    config.Routes.MapHttpRoute(
        name: "DefaultApi",
        routeTemplate: "api/{controller}/{id}",
        defaults: new { id = RouteParameter.Optional }
    );

    config.SetTimeZoneInfo(TimeZoneInfo.Utc);

    ODataConventionModelBuilder builder = new ODataConventionModelBuilder();

    builder.EntitySet<Product>("Products");
    builder.EntityType<Product>().HasKey(entity => entity.ProductId);
    builder.EntityType<Product>().HasRequired(entity => entity.ProductType, (entity, targetEntity) => entity.ProductTypeId == targetEntity.ProductTypeId);
    builder.EntitySet<ProductType>("ProductTypes");
    builder.EntityType<ProductType>().HasKey(entity => entity.ProductTypeId);
    builder.EntityType<ProductType>().HasMany(entity => entity.Products);

    config.MapODataServiceRoute("odata", "odata", builder.GetEdmModel());

    config.Formatters.JsonFormatter.SupportedMediaTypes.Add(new MediaTypeHeaderValue("text/html"));

}

// ProductTypesController.cs
public class ProductTypesController : BaseController
{
    [EnableQuery]
    public IQueryable<ProductType> Get()
    {
        return db.ProductTypes;
    }

    [EnableQuery]
    public SingleResult<ProductType> Get([FromODataUri] int key)
    {
        IQueryable<ProductType> result = db.ProductTypes.Where(p => p.ProductTypeId.Equals(key));
        return SingleResult.Create(result);
    }
    ....
}

// ProductsController.cs
public class ProductsController : BaseController
{

    [EnableQuery]
    public IQueryable<Product> Get()
    {
        return db.Products;
    }

    [EnableQuery]
    public SingleResult<Product> Get([FromODataUri] int key)
    {
        IQueryable<Product> result = db.Products.Where(p => p.ProductId.Equals(key));
        return SingleResult.Create(result);
    }
    ...
}

我已经尝试过使用单项和多项选择来引用相关项的两个方向(将这些网址键入地址栏): /ProductTypes?$expand=Products/ProductTypes(3)?$expand=Products/Products?$expand=ProductType/Products(3)?$expand=ProductType 在每种情况下,我都会遇到相同的错误。 如果还有其他原因需要确定原因,我很乐意查找,我只需要知道在哪里查找即可。

谢谢,迈克

1 个答案:

答案 0 :(得分:0)

我在odata github问题的帖子中找到了答案。 issuecomment-248168536根据此评论,这是Microsoft.AspNet.OData软件包6.0.0版中的新行为,是一项重大更改。 我回到另一个正在运行的服务,并检查了Nuget软件包,它安装了v 5.6.0,而不是最新的(当前为7.1.0)。

因此解决方法是在映射之前为所需的功能添加配置行...

config.Expand().Select();
config.MapODataServiceRoute("odata", null, builder.GetEdmModel());

这是用于全局启用该选项以使其像13-01-modelbound-attribute)中引用了一个文档,该文档演示了通过模型属性对选项进行精细控制的新功能。

HTH,迈克