Возврат WebAPI и ODataController 406 Не допускается

Перед добавлением 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

Все контроллеры предоставляют Get, Put (имя действия Create), Patch (имя действия - Update) и Delete. В качестве примера клиент использует эти различные стандартные 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";

Затем я добавил контроллер OData с теми же именами действий, что и мои другие контроллеры Api. Я также добавил новый маршрут:

        ODataConfig odataConfig = new ODataConfig();

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

Пока я ничего не изменил на стороне клиента. Когда я отправляю запрос, я получаю ошибку 406 Not Available.

Перепутаны ли маршруты? Как я могу это решить?

ОТВЕТЫ

Ответ 1

Порядок, в котором настроены маршруты, оказывает влияние. В моем случае у меня также есть стандартные контроллеры 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);
}

Элементы фильтра и routeTable не были там, когда я начал свой проект и нужен.

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.

Поэтому я могу позвонить:

localhost: xxx/- > приводит к страницам справки (домашний контроллер, индексная страница)

localhost: xxx/api/- > приводит к метаданным OData $

localhost: xxx/api/Sites → приводит к методу Get моего SiteController, наследующему от ODataController

localhost: xxx/api/Test → приводит к методу Get моего TestController, наследующему от ApiController.

Ответ 2

Если вы используете OData V4, замените using System.Web.Http.OData;

С using System.Web.OData; (Пожалуйста, проверьте комментарии для последней библиотеки)

у меня в ODataController работает.

Ответ 3

Установите для параметра 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.

Ответ 4

Еще одна вещь, которую нужно учитывать, это то, что URL-адрес чувствителен к регистру, поэтому:

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

Ответ 5

Моя проблема была связана с возвратом модели сущности вместо открытой модели (builder.EntitySet<ProductModel>("Products");). Решением было сопоставление объекта с моделью ресурсов.

Ответ 6

Ни один из превосходных решений на этой странице не работал у меня. По отладке я мог видеть, что маршрут подбирался и запросы OData выполнялись правильно. Тем не менее, они вырвались из строя после выхода контроллера, который предположил, что именно форматирование генерирует то, что кажется обходной ошибкой OData: 406 Not Acceptable.

Я исправил это, добавив пользовательский форматировщик, основанный на библиотеке 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());
    }
}

Ответ 7

Проблема у меня была в том, что я назвал свою сущность "Продукты" и имел ProductController. Оказывается, имя набора объектов должно соответствовать имени вашего контроллера.

So

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

с контроллером ProductController выдаст ошибки.

/api/Продукт даст 406

/api/Продукты предоставят 404

Итак, используя некоторые из новых функций С# 6, мы можем это сделать:

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

Ответ 8

Проблема/решение в моем случае было еще более глупо. Я оставил тестовый код в своем действии, который вернул совершенно другой тип модели, всего лишь Dictionary, а не мой правильный тип модели EDM.

Хотя я возражаю против того, что использование HTTP 406 Not Acceptable для передачи ошибки моих способов одинаково глупо.

Ответ 9

Найдено в ошибке 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

Ответ 10

Моя ошибка и исправление были отличны от ответов выше.

Конкретной проблемой я был доступ к mediaReadLink точке mediaReadLink в моем ODataController в WebApi 2.2.

OData имеет свойство "default stream" в спецификации, которое позволяет возвращенному объекту иметь вложение. Таким образом, объект json для filter т.д. Описывает объект, а затем есть встроенная медиасвязь, к которой также можно получить доступ. В моем случае это 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. 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")] является способ встраивания и использования медиа-ссылок в OData V4 с помощью web api 2.2. Для полноты я дам полную настройку ниже.

Во-первых, в моем 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.

Ответ 11

В моем случае мне нужно было изменить средство публичного доступа к публике.

public string PersonHairColorText { get; internal set; }

Необходимо изменить на:

public string PersonHairColorText { get; set; }

Ответ 12

В моем случае (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);
        });            
    }
}

Ответ 13

Для меня проблема заключалась в том, что я использовал 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);