WebAPI 和 ODataController 返回 406 不可接受

本文关键字：不可接受 返回 ODataController WebAPI | 更新日期: 2023-09-27 18:28:33

在将OData添加到我的项目之前，我的路由设置如下：

       config.Routes.MapHttpRoute(
            name: "ApiById",
            routeTemplate: "api/{controller}/{id}",
            defaults: new { id = RouteParameter.Optional },
            constraints: new { id = @"^[0-9]+$" },
            handler: sessionHandler
        );
        config.Routes.MapHttpRoute(
            name: "ApiByAction",
            routeTemplate: "api/{controller}/{action}",
            defaults: new { action = "Get" },
            constraints: null,
            handler: sessionHandler
        );
        config.Routes.MapHttpRoute(
            name: "ApiByIdAction",
            routeTemplate: "api/{controller}/{id}/{action}",
            defaults: new { id = RouteParameter.Optional },
            constraints: new { id = @"^[0-9]+$" },
            handler: sessionHandler

所有控制器都提供获取、放置(操作名称为创建(、修补程序(操作名称为更新(和删除。例如，客户端将这些不同的标准 url 用于 CustomerType 请求：

string getUrl =  "api/CustomerType/{0}";
string findUrl = "api/CustomerType/Find?param={0}";
string createUrl = "api/CustomerType/Create";
string updateUrl = "api/CustomerType/Update";
string deleteUrl = "api/CustomerType/{0}/Delete";

然后，我添加了一个与其他 API 控制器具有相同操作名称的 OData 控制器。我还添加了一条新路线：

        ODataConfig odataConfig = new ODataConfig();
        config.MapODataServiceRoute(
            routeName: "ODataRoute",
            routePrefix: null,
            model: odataConfig.GetEdmModel()
        );

到目前为止，我在客户端没有任何变化。当我发送请求时，我收到"406 不可用"错误。

路线是否变得混乱？我该如何解决这个问题？

WebAPI 和 ODataController 返回 406 不可接受

如果您使用的是 OData V4，请替换using System.Web.Http.OData;

带using Microsoft.AspNet.OData;(请查看最新库的评论(

在 ODataController 中为我工作。

路由的配置顺序有影响。就我而言，我也有一些标准的MVC控制器和帮助页面。所以在Global.asax：

protected void Application_Start()
{
    AreaRegistration.RegisterAllAreas();
    GlobalConfiguration.Configure(config =>
    {
        ODataConfig.Register(config); //this has to be before WebApi
        WebApiConfig.Register(config); 
    });
    FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
    RouteConfig.RegisterRoutes(RouteTable.Routes);
}

当我开始我的项目时，过滤器和路由表部分不存在，并且是必需的。

ODataConfig.cs ：

public static void Register(HttpConfiguration config)
{
    config.MapHttpAttributeRoutes(); //This has to be called before the following OData mapping, so also before WebApi mapping
    ODataConventionModelBuilder builder = new ODataConventionModelBuilder();
    builder.EntitySet<Site>("Sites");
    //Moar!
    config.MapODataServiceRoute("ODataRoute", "api", builder.GetEdmModel());
}

WebApiConfig.cs ：

public static void Register(HttpConfiguration config)
{
    config.Routes.MapHttpRoute( //MapHTTPRoute for controllers inheriting ApiController
            name: "DefaultApi",
            routeTemplate: "api/{controller}/{id}",
            defaults: new { id = RouteParameter.Optional }
    );
}

作为奖励，这是我RouteConfig.cs：

public static void RegisterRoutes(RouteCollection routes)
{
    routes.IgnoreRoute("{resource}.axd/{*pathInfo}");
    routes.MapRoute( //MapRoute for controllers inheriting from standard Controller
        name: "Default",
        url: "{controller}/{action}/{id}",
        defaults: new { controller = "Home", action = "Index", id = UrlParameter.Optional }
    );
}

这必须按照确切的顺序。我尝试移动调用，最终 MVC、API 或 Odata 因 404 或 406 错误而中断。

所以我可以打电话：

本地主机：xxx/-> 指向帮助页面(主控制器、索引页(

本地主机：xxx/api/-> 导致 OData $metadata

localhost：xxx/api/Sites -> 导致我的站点控制器从 ODataController 继承的 Get 方法

。

localhost：xxx/api/Test -> 导致我的 TestController 从 ApiController 继承的 Get 方法。

将 routePrefix 设置为 "api"。

ODataConventionModelBuilder builder = new ODataConventionModelBuilder();
builder.EntitySet<CustomerType>("CustomerType");
config.MapODataServiceRoute(routeName: "ODataRoute", routePrefix: "api", model: builder.GetEdmModel());

您使用的是哪个 OData 版本？检查命名空间是否正确，对于 OData V4，请使用 System.Web.OData ，对于 V3 System.Web.Http.OData 。控制器中使用的命名空间必须与 WebApiConfig 中使用的命名空间一致。

我的问题与返回实体模型而不是我公开的模型有关(builder.EntitySet<ProductModel>("Products");(。解决方案是将实体映射到资源模型。

要考虑的另一件事是 URL 区分大小写，因此：


localhost:xxx/api/Sites -> OK localhost:xxx/api/sites -> HTTP 406

我遇到的问题是我将我的实体集命名为"产品"并有一个产品控制器。事实证明，实体集的名称必须与控制器名称匹配。

所以 

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

使用名为 ProductController 的控制器将给出错误。

/

api/Product 将给出 406

/

api/Products 将给出 404

因此，使用一些新的 C# 6 功能，我们可以改为执行此操作：

builder.EntitySet<Product>(nameof(ProductsController).Replace("Controller", string.Empty));

此页面上的出色解决方案都不适合我。 通过调试，我可以看到路由正在被拾取，并且 OData 查询运行正常。 但是，在控制器退出后，它们被破坏了，这表明是格式生成了似乎是 OData 捕获所有错误：406 不可接受。

我通过添加基于 Json.NET 库的自定义格式化程序来解决此问题：

public class JsonDotNetFormatter : MediaTypeFormatter
{
    public JsonDotNetFormatter()
    {
        SupportedMediaTypes.Add(new MediaTypeHeaderValue("application/json"));
    }
    public override bool CanReadType(Type type)
    {
        return true;
    }
    public override bool CanWriteType(Type type)
    {
        return true;
    }
    public override async Task<object> ReadFromStreamAsync(Type type, Stream readStream, HttpContent content, IFormatterLogger formatterLogger)
    {
        using (var reader = new StreamReader(readStream))
        {
            return JsonConvert.DeserializeObject(await reader.ReadToEndAsync(), type);
        }
    }
    public override async Task WriteToStreamAsync(Type type, object value, Stream writeStream, HttpContent content, TransportContext transportContext)
    {
        if (value == null) return;
        using (var writer = new StreamWriter(writeStream))
        {
            await writer.WriteAsync(JsonConvert.SerializeObject(value, new JsonSerializerSettings {ReferenceLoopHandling = ReferenceLoopHandling.Ignore}));
        }
    }

然后在WebApiConfig.cs，我添加了config.Formatters.Insert(0, new JsonDotNetFormatter())行。 请注意，我严格遵守杰瑟回答中描述的顺序。

public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        ConfigureODataRoutes(config);
        ConfigureWebApiRoutes(config);
    }
    private static void ConfigureWebApiRoutes(HttpConfiguration config)
    {
        config.Routes.MapHttpRoute("DefaultApi", "api/{controller}/{id}", new { id = RouteParameter.Optional });
    }
    private static void ConfigureODataRoutes(HttpConfiguration config)
    {
        config.MapHttpAttributeRoutes();
        config.Formatters.Insert(0, new JsonDotNetFormatter());
        var builder = new ODataConventionModelBuilder();
        builder.EntitySet<...>("<myendpoint>");
        ...
        config.MapODataServiceRoute("ODataRoute", "odata", builder.GetEdmModel());
    }
}

我的问题/解决方案更加愚蠢。我在操作中留下了测试代码，该代码返回了完全不同的模型类型，只是一个Dictionary，而不是我正确的 EDM 模型类型。

虽然我抗议使用HTTP 406 Not Acceptable来传达我的方式的错误，但同样愚蠢。

我的错误和修复与上面的答案不同。

我遇到的具体问题是在 WebApi 2.2 中的 ODataController 中访问mediaReadLink终结点。

OData 在规范中具有"默认流"属性，该属性允许返回的实体具有附件。因此，例如用于filter等的json对象描述了该对象，然后嵌入了一个媒体链接，也可以访问该链接。在我的例子中，它是所描述对象的PDF版本。

这里有一些卷曲的问题，第一个来自配置：

<system.web>
  <customErrors mode="Off" />
  <compilation debug="true" targetFramework="4.7.1" />
  <httpRuntime targetFramework="4.5" />
  <!-- etc -->
</system.web>

起初我试图返回一个FileStreamResult，但我相信这不是默认的 net45 运行时。 因此，管道无法将其格式化为响应，并且随之而来的是 406 不可接受。

此处的修复是返回HttpResponseMessage并手动构建内容：

    [System.Web.Http.HttpGet]
    [System.Web.Http.Route("myobjdownload")]
    public HttpResponseMessage DownloadMyObj(string id)
    {
        try
        {
            var myObj = GetMyObj(id); // however you do this                
            if (null != myObj )
            {
                HttpResponseMessage result = Request.CreateResponse(HttpStatusCode.OK);
                byte[] bytes = GetMyObjBytes(id); // however you do this
                result.Content = new StreamContent(bytes); 
                result.Content.Headers.ContentType = new MediaTypeWithQualityHeaderValue("application/pdf");
                result.Content.Headers.LastModified = DateTimeOffset.Now;  
                result.Content.Headers.ContentDisposition = new ContentDispositionHeaderValue(DispositionTypeNames.Attachment)
                {
                    FileName = string.Format("{0}.pdf", id),
                    Size = bytes.length,
                    CreationDate = DateTimeOffset.Now,
                    ModificationDate = DateTimeOffset.Now
                };
                 return  result;
            }
        }
        catch (Exception e)
        {
            // log, throw 
        }
        return null;
    }

我在这里的最后一个问题是在返回有效结果后出现意外的 500 错误。添加常规异常过滤器后，我发现错误Queries can not be applied to a response content of type 'System.Net.Http.StreamContent'. The response content must be an ObjectContent.。此处的解决方法是从控制器声明的顶部删除 [EnableQuery] 属性，并且仅在返回实体对象的终结点的操作级别应用该属性。

[System.Web.Http.Route("myobjdownload")]属性是如何使用 Web api 2.2 在 OData V4 中嵌入和使用媒体链接。为了完整起见，我将在下面转储它的完整设置。

首先，在我的Startup.cs：

[assembly: OwinStartup(typeof(MyAPI.Startup))]
namespace MyAPI
{
    public class Startup
    {
        public void Configuration(IAppBuilder app)
        {
            // DI etc
            // ...
            GlobalConfiguration.Configure(ODataConfig.Register); // 1st
            GlobalConfiguration.Configure(WebApiConfig.Register); // 2nd      
            // ... filters, routes, bundles etc
            GlobalConfiguration.Configuration.EnsureInitialized();
        }
    }
}

ODataConfig.cs ：

// your ns above
public static class ODataConfig
{
    public static void Register(HttpConfiguration config)
    {
        ODataConventionModelBuilder builder = new ODataConventionModelBuilder();
        var entity1 = builder.EntitySet<MyObj>("myobj");
        entity1.EntityType.HasKey(x => x.Id);
        // etc
        var model = builder.GetEdmModel();
        // tell odata that this entity object has a stream attached
        var entityType1 = model.FindDeclaredType(typeof(MyObj).FullName);
        model.SetHasDefaultStream(entityType1 as IEdmEntityType, hasStream: true);
        // etc
        config.Formatters.InsertRange(
                                    0, 
                                    ODataMediaTypeFormatters.Create(
                                                                    new MySerializerProvider(),
                                                                    new DefaultODataDeserializerProvider()
                                                                    )
                                    );
        config.Select().Expand().Filter().OrderBy().MaxTop(null).Count();
        // note: this calls config.MapHttpAttributeRoutes internally
        config.Routes.MapODataServiceRoute("ODataRoute", "data", model);
        // in my case, i want a json-only api - ymmv
        config.Formatters.JsonFormatter.SupportedMediaTypes.Add(new MediaTypeWithQualityHeaderValue("text/html"));
        config.Formatters.Remove(config.Formatters.XmlFormatter);
    }
}

WebApiConfig.cs ：

// your ns above
public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        // https://stackoverflow.com/questions/41697934/catch-all-exception-in-asp-net-mvc-web-api
        //config.Filters.Add(new ExceptionFilter());
        // ymmv
        var cors = new EnableCorsAttribute("*", "*", "*");
        config.EnableCors(cors);
        // so web api controllers still work
        config.Routes.MapHttpRoute(
            name: "DefaultApi",
            routeTemplate: "{controller}/{id}",
            defaults: new { id = RouteParameter.Optional }
        );
        // this is the stream endpoint route for odata
        config.Routes.MapHttpRoute("myobjdownload", "data/myobj/{id}/content", new { controller = "MyObj", action = "DownloadMyObj" }, null);
        // etc MyObj2
    }
}

MySerializerProvider.cs ：

public class MySerializerProvider: DefaultODataSerializerProvider
{
    private readonly Dictionary<string, ODataEdmTypeSerializer> _EntitySerializers;
    public SerializerProvider()
    {
        _EntitySerializers = new Dictionary<string, ODataEdmTypeSerializer>();
        _EntitySerializers[typeof(MyObj).FullName] = new MyObjEntitySerializer(this);
        //etc 
    }
    public override ODataEdmTypeSerializer GetEdmTypeSerializer(IEdmTypeReference edmType)
    {
        if (edmType.IsEntity())
        {
            string stripped_type = StripEdmTypeString(edmType.ToString());
            if (_EntitySerializers.ContainsKey(stripped_type))
            {
                return _EntitySerializers[stripped_type];
            }
        }            
        return base.GetEdmTypeSerializer(edmType);
    }
    private static string StripEdmTypeString(string t)
    {
        string result = t;
        try
        {
            result = t.Substring(t.IndexOf('[') + 1).Split(' ')[0];
        }
        catch (Exception e)
        {
            //
        }
        return result;
    }
}

MyObjEntitySerializer.cs ：

public class MyObjEntitySerializer : DefaultStreamAwareEntityTypeSerializer<MyObj>
{
    public MyObjEntitySerializer(ODataSerializerProvider serializerProvider) : base(serializerProvider)
    {
    }
    public override Uri BuildLinkForStreamProperty(MyObj entity, EntityInstanceContext context)
    {
        var url = new UrlHelper(context.Request);
        string id = string.Format("?id={0}", entity.Id);
        var routeParams = new { id }; // add other params here
        return new Uri(url.Link("myobjdownload", routeParams), UriKind.Absolute);            
    }
    public override string ContentType
    {
        get { return "application/pdf"; }            
    }
}

DefaultStreamAwareEntityTypeSerializer.cs ：

public abstract class DefaultStreamAwareEntityTypeSerializer<T> : ODataEntityTypeSerializer where T : class
{
    protected DefaultStreamAwareEntityTypeSerializer(ODataSerializerProvider serializerProvider)
        : base(serializerProvider)
    {
    }
    public override ODataEntry CreateEntry(SelectExpandNode selectExpandNode, EntityInstanceContext entityInstanceContext)
    {
        var entry = base.CreateEntry(selectExpandNode, entityInstanceContext);
        var instance = entityInstanceContext.EntityInstance as T;
        if (instance != null)
        {
            entry.MediaResource = new ODataStreamReferenceValue
            {
                ContentType = ContentType,
                ReadLink = BuildLinkForStreamProperty(instance, entityInstanceContext)
            };
        }
        return entry;
    }
    public virtual string ContentType
    {
        get { return "application/octet-stream"; }
    }
    public abstract Uri BuildLinkForStreamProperty(T entity, EntityInstanceContext entityInstanceContext);
}

最终结果是我的 json 对象嵌入了这些 odata 属性：

odata.mediaContentType=application/pdf
odata.mediaReadLink=http://myhost/data/myobj/%3fid%3dmyid/content

以下解码媒体链接http://myhost/data/myobj/?id=myid/content在您的MyObjController : ODataController上触发端点。

在

GitHub 错误中找到：">默认情况下无法使用 odata $select、$expand 和其他 #511">，他们的解决方案是在注册路由之前放置以下行：

// enable query options for all properties
config.Filter().Expand().Select().OrderBy().MaxTop(null).Count();
对我来说

就像一个魅力。

来源： https://github.com/OData/RESTier/issues/511

就我而言，我需要将非公共属性设置器更改为公共属性。

public string PersonHairColorText { get; internal set; }

需要更改为：

public string PersonHairColorText { get; set; }

在我的情况下(odata V3(，我不得不将OdataController的名称更改为与中提供的名称相同ODataConventionModelBuilder，解决了这个问题

我的控制器：

public class RolesController : ODataController
{
    private AngularCRMDBEntities db = new AngularCRMDBEntities();
    [Queryable]
    public IQueryable<tROLE> GetRoles()
    {
        return db.tROLEs;
    }
}

ODataConfig.cs：

public class ODataConfig
{
    public static void Register(HttpConfiguration config)
    {
        ODataConventionModelBuilder modelBuilder = new ODataConventionModelBuilder();
        modelBuilder.EntitySet<WMRole>("RolesNormal"); 
        modelBuilder.EntitySet<WMCommon.DAL.EF.tROLE>("Roles").EntityType.HasKey(o => o.IDRole).HasMany(t => t.tROLE_AUTHORIZATION);
        modelBuilder.EntitySet<WMCommon.DAL.EF.tLOOKUP>("Lookups").EntityType.HasKey(o => o.IDLookup).HasMany(t => t.tROLE_AUTHORIZATION);
        modelBuilder.EntitySet<WMCommon.DAL.EF.tROLE_AUTHORIZATION>("RoleAuthorizations").EntityType.HasKey(o => o.IDRoleAuthorization);
        config.Routes.MapODataRoute("odata", "odata", modelBuilder.GetEdmModel());
        config.EnableQuerySupport();
    }
}

WebApiConfig.cs：

public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        // Web API configuration and services
        // Web API routes
        config.MapHttpAttributeRoutes();
        config.SuppressDefaultHostAuthentication();
        config.Filters.Add(new HostAuthenticationFilter(OAuthDefaults.AuthenticationType));            
        config.Routes.MapHttpRoute( //MapHTTPRoute for controllers inheriting ApiController
            name: "DefaultApi",
            routeTemplate: "api/{controller}/{id}",
            defaults: new { id = RouteParameter.Optional }
            );
        var jsonFormatter = config.Formatters.OfType<JsonMediaTypeFormatter>().First();
        jsonFormatter.SerializerSettings.ContractResolver = new CamelCasePropertyNamesContractResolver();
        GlobalConfiguration.Configuration.Formatters.JsonFormatter.SerializerSettings
            .ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore;
        GlobalConfiguration.Configuration.Formatters
            .Remove(GlobalConfiguration.Configuration.Formatters.XmlFormatter);
    }
}

Global.asax：

public class WebApiApplication : System.Web.HttpApplication
{
    protected void Application_Start()
    {
        GlobalConfiguration.Configure(config =>
        {
            ODataConfig.Register(config); 
            WebApiConfig.Register(config);
        });            
    }
}

对我来说，问题是我使用 LINQ 并直接选择了加载的对象。我必须使用select new才能工作：

return Ok(from u in db.Users
          where u.UserId == key
          select new User
          {
              UserId = u.UserId,
              Name = u.Name
          });

这不起作用：

return Ok(from u in db.Users
          where u.UserId == key
          select u);
相关文章：