具有多个参数的 OData 控制器方法

Question

我需要用这个分配创建一个 OData 控制器。

http://xxxxxx/odata/mock/Itens(NumContrato='1234',IdItem='10')/Pedidos

ItensController

public class ItensController : ODataController
{
    [HttpPost]
    [ODataRoute("(NumContrato={NumContrato},IdItem={IdItem})/Pedidos")]
    public IQueryable<Pedido> Pedidos([FromODataUri] string NumContrato, [FromODataUri] string IdItem)
    {
        ... do something
    }
}

WebApiConfig.cs

...
config.Routes.MapODataServiceRoute(
        "ODataRoute",
        "odata/mock",
        model: GetModel(),
        new DefaultODataBatchHandler(GlobalConfiguration.DefaultServer));
...

public static IEdmModel GetModel()
{
    ODataModelBuilder builder = new ODataConventionModelBuilder();
    ...
    builder.EntitySet<Dominio.ODataSapFake.Item>("Itens");
    builder.EntitySet<Dominio.ODataSapFake.LinhaDeServico>("LinhasDeServicos");
    builder.EntitySet<Dominio.ODataSapFake.Pedido>("Pedidos");
    var a = builder.Entity<Dominio.ODataSapFake.Item>().Collection.Action("Pedidos");
    a.Parameter<string>("NumContrato");
    a.Parameter<string>("IdItem");
    a.ReturnsCollectionFromEntitySet<Dominio.ODataSapFake.Pedido>("Pedidos");
    ...
    return builder.GetEdmModel();
}

调用服务时出错。

<m:error xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata">
    <m:code/>
    <m:message xml:lang="en-US">
        No HTTP resource was found that matches the request URI 'http://localhost:4492/odata/mock/Itens(NumContrato='100',IdItem='00040')/Pedidos'.
    </m:message>
    <m:innererror>
        <m:message>No routing convention was found to select an action for the OData path with template '~/entityset/key/navigation'.
        </m:message>
        <m:type/>
        <m:stacktrace/>
    </m:innererror>
</m:error>

Answer 1

要么你的 URL 不正确，要么你的配置不正确，让我们探索这两种可能性：

假设配置正确，你声明了名为Pedidos的Action有2个参数，它绑定到collection，没有绑定到一个项目。 . 符合你定义的网址其实是：

~/Itens/Pedidos(NumContrato='1234',IdItem='10')

假设 URL 正确，那么您需要将端点配置为 Item 绑定 Action 并且我们还假设 Itens 记录已经具有键 @ 987654325@ 和 IdItem 定义：

builder.EntitySet<Dominio.ODataSapFake.LinhaDeServico>("LinhasDeServicos");
builder.EntitySet<Dominio.ODataSapFake.Pedido>("Pedidos");
var itens = builder.EntitySet<Dominio.ODataSapFake.Item>("Itens");
// Key should be defined by attribute notation, but we can redefine it here for clarity
itens.EntityType.HasKey(x => x.NumContrato);
itens.EntityType.HasKey(x => x.IdItem);
// declare the Action bound to an Item
itens.Item.Action("Pedidos")
    .ReturnsCollectionFromEntitySet<Dominio.ODataSapFake.Pedido>("Pedidos");

更新 1 - 获取支持：

Action 支持 HTTP Post，OP 已经用它装饰了方法，但是如果您打算支持 HTTP GET，那么您必须将端点配置为 Function。语法还是一样的。

• 不要忘记删除[HttpPost]属性，考虑用[EnableQuery]或[HttpGet]替换它

更新 2 - 使用复合键进行项目导航

如果Item 数据记录有一个名为Pedidos 的导航属性，并且您的意图是支持沿此属性路径向下的标准项目导航，那么您不需要在配置中包含此信息。

• 删除[HttpPost]，这是一个GET请求。
• 删除[ODataRoute] 属性，默认路由应该可以工作
• 确保使用关键属性的名称，使用与配置中声明的相同的大小写和顺序。
  • 如果您使用自动配置，则顺序将与您的数据模型中的 Key 属性列规范相匹配。
• 对于 OData v3，您可能需要遵循以下建议：Odata v3 Web Api navigation with composite key