Не вдалося серіалізувати відповідь у веб-API за допомогою Json

Я працюю з ASP.NET MVC 5 Web Api. Я хочу проконсультуватися з усіма своїми користувачами.

Я написав api/usersі отримую це:

"Тип" ObjectContent`1 "не вдалося серіалізувати тіло відповіді для типу вмісту" application / json; charset = utf-8 ""

У WebApiConfig я вже додав ці рядки:

HttpConfiguration config = new HttpConfiguration();
config.Formatters.XmlFormatter.SupportedMediaTypes.Remove(appXmlType);
config.Formatters.JsonFormatter.SerializerSettings.ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore; 

Але це все ще не працює.

Моя функція повернення даних така:

public IEnumerable<User> GetAll()
{
    using (Database db = new Database())
    {
        return db.Users.ToList();
    }
}

Що стосується повернення даних споживачеві з веб-сервісу Api (або будь-якого іншого веб-сервісу з цього приводу), я настійно рекомендую не передавати назад об’єкти, що надходять із бази даних. Набагато надійніше та рентабельніше використовувати Моделі, в яких ви маєте контроль над тим, як виглядають дані, а не з базою даних. Таким чином, вам не доведеться сильно возитися з форматерами в WebApiConfig. Ви можете просто створити UserModel, який має дочірні Моделі як властивості, і позбутися від циклів посилань у об'єктах, що повертаються. Це робить серіалізатор набагато щасливішим.

Крім того, не потрібно видаляти форматери або підтримувані типи носіїв, як правило, ви просто вказуєте заголовок "Приймає". Граючи з цими речами, іноді можуть зробити речі більш заплутаними.

Приклад:

public class UserModel {
    public string Name {get;set;}
    public string Age {get;set;}
    // Other properties here that do not reference another UserModel class.
}

Якщо ви працюєте з EF, до того ж додайте код нижче на Global.asax

GlobalConfiguration.Configuration.Formatters.JsonFormatter.SerializerSettings
    .ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore;
GlobalConfiguration.Configuration.Formatters
    .Remove(GlobalConfiguration.Configuration.Formatters.XmlFormatter);          

Не забудьте імпортувати

using System.Data.Entity;

Тоді ви можете повернути власні моделі EF

Просто як це!

Надана правильна відповідь - це один із способів, однак це надмірність, коли ви можете виправити це за допомогою одного конфігураційного налаштування.

Краще використовувати його в конструкторі dbcontext

public DbContext() // dbcontext constructor
            : base("name=ConnectionStringNameFromWebConfig")
{
     this.Configuration.LazyLoadingEnabled = false;
     this.Configuration.ProxyCreationEnabled = false;
}

Помилка веб-API Asp.Net: тип "ObjectContent`1" не вдалося серіалізувати тіло відповіді для типу вмісту "application / xml; charset = utf-8 '

Додайте цей код global.asaxнижче на Application_Start:

Оновлення від .Ignoreдо .Serialize. Це має працювати.

GlobalConfiguration.Configuration.Formatters.JsonFormatter.SerializerSettings.ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Serialize;
            GlobalConfiguration.Configuration.Formatters.Remove(GlobalConfiguration.Configuration.Formatters.XmlFormatter);

public class UserController : ApiController
{

   Database db = new Database();

   // construction
   public UserController()
   {
      // Add the following code
      // problem will be solved
      db.Configuration.ProxyCreationEnabled = false;
   }

   public IEnumerable<User> GetAll()
    {
            return db.Users.ToList();
    }
}

Мені цей код не подобається:

foreach(var user in db.Users)

Як альтернатива, можна зробити щось подібне, що працювало для мене:

var listOfUsers = db.Users.Select(r => new UserModel
                         {
                             userModel.FirstName = r.FirstName;
                             userModel.LastName = r.LastName;

                         });

return listOfUsers.ToList();

Однак я в кінцевому підсумку застосував рішення Лукаса Розеллі.

Оновлення: спрощено шляхом повернення анонімного об'єкта:

var listOfUsers = db.Users.Select(r => new 
                         {
                             FirstName = r.FirstName;
                             LastName = r.LastName;
                         });

return listOfUsers.ToList();

Я вирішив це за допомогою цього коду до файлу WebApiConfig.cs

var json = config.Formatters.JsonFormatter;
json.SerializerSettings.PreserveReferencesHandling = Newtonsoft.Json.PreserveReferencesHandling.Objects; 
config.Formatters.Remove(config.Formatters.XmlFormatter);

Існує також цей сценарій, який генерує ту саму помилку:

У випадку повернення - це List<dynamic>метод api до веб-сторінки

Приклад:

public HttpResponseMessage Get()
{
    var item = new List<dynamic> { new TestClass { Name = "Ale", Age = 30 } };

    return Request.CreateResponse(HttpStatusCode.OK, item);
}

public class TestClass
{
    public string Name { get; set; }
    public int Age { get; set; }
}

Отже, для цього сценарію використовуйте [K knownTypeAttribute] у класі повернення (усі вони) таким чином:

[KnownTypeAttribute(typeof(TestClass))]
public class TestClass
{
    public string Name { get; set; }
    public int Age { get; set; }
}

Це працює для мене!

Додавання цього до вашого Application_Start()методу Global.asaxфайлу має вирішити проблему

protected void Application_Start()
{
    GlobalConfiguration.Configuration.Formatters.JsonFormatter.SerializerSettings
        .ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore;
    GlobalConfiguration.Configuration.Formatters
        .Remove(GlobalConfiguration.Configuration.Formatters.XmlFormatter); 
// ...
}

МЕТОД 2: [Не рекомендується]
Якщо ви працюєте з EntityFramework, ви можете відключити проксі в конструкторі класу DbContext. ПРИМІТКА. Цей код буде видалено, якщо ви оновите модель

public class MyDbContext : DbContext
{
  public MyDbContext()
  {
    this.Configuration.ProxyCreationEnabled = false;
  }
}

Мій особистий фаворит: Просто додайте код нижче до App_Start/WebApiConfig.cs. Це поверне json замість XML за замовчуванням, а також запобіжить виникнення помилки. Global.asaxДля видалення XmlFormatterтощо не потрібно редагувати

Тип "ObjectContent`1" не вдалося серіалізувати тіло відповіді для типу вмісту "application / xml; charset = utf-8

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

Використовувати Автоматичне складання ...

public IEnumerable<User> GetAll()
    {
        using (Database db = new Database())
        {
            var users = AutoMapper.Mapper.DynamicMap<List<User>>(db.Users);
            return users;
        }
    }

Використовуйте таке простір імен:

using System.Web.OData;

Замість :

using System.Web.Http.OData;

Це працювало для мене

Додайте рядок нижче

this.Configuration.ProxyCreationEnabled = false;

Два способи використання ProxyCreationEnabledяк false.

1. Додайте його всередину DBContextConstructor

   public ProductEntities() : base("name=ProductEntities")
   {
       this.Configuration.ProxyCreationEnabled = false;
   }

АБО

2. Додайте рядок всередину Getметоду

   public IEnumerable<Brand_Details> Get()
   {
       using (ProductEntities obj = new ProductEntities())
       {
           this.Configuration.ProxyCreationEnabled = false;
           return obj.Brand_Details.ToList();
       }
   }

Рішення, яке працювало для мене:

1. Використовуйте [DataContract]для класу та [DataMember]атрибутів для кожного ресурсу серіалізацію. Цього цілком достатньо, щоб отримати результат Json (наприклад, від fiddler).

2. Щоб отримати xml серіалізацію, напишіть у Global.asaxцей код:

   var xml = GlobalConfiguration.Configuration.Formatters.XmlFormatter; xml.UseXmlSerializer = true;

3. Читайте цю статтю, це допомогло мені зрозуміти серіалізацію: https://www.asp.net/web-api/overview/formats-and-model-binding/json-and-xml-serialization

Щоб додати до відповіді jensendp:

Я передавав би сутність для створеної користувачем моделі і використовував значення цього об'єкта для встановлення значень у вашій щойно створеній моделі. Наприклад:

public class UserInformation {
   public string Name { get; set; }
   public int Age { get; set; }

   public UserInformation(UserEntity user) {
      this.Name = user.name;
      this.Age = user.age;
   }
}

Потім змініть тип повернення на: IEnumerable<UserInformation>

Я в основному додаю один рядок, який вони є

• Субстанції.Configuration.ProxyCreationEnabled = false;

до UsersController.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Web.Http;
using UserDataAccess;

namespace SBPMS.Controllers
{
    public class UsersController : ApiController
    {


        public IEnumerable<User> Get() {
            using (SBPMSystemEntities entities = new SBPMSystemEntities()) {
                entities.Configuration.ProxyCreationEnabled = false;
                return entities.Users.ToList();
            }
        }
        public User Get(int id) {
            using (SBPMSystemEntities entities = new SBPMSystemEntities()) {
                entities.Configuration.ProxyCreationEnabled = false;
                return entities.Users.FirstOrDefault(e => e.user_ID == id);
            }
        }
    }
}

Використовуйте [Serializable] для класу:

Приклад:

[Serializable]
public class UserModel {
    public string Name {get;set;}
    public string Age {get;set;}
}

Це працювало на мене!

Вам потрібно буде визначити формат серіалізатора в WebApiConfig.cs, доступному в App_Start Folder, як

Додавання config.Formatters.Remove (config.Formatters.XmlFormatter); // який надасть вам дані у форматі JSON

Додавання config.Formatters.Remove (config.Formatters.JsonFormatter); // який надасть вам дані у форматі XML

Просто поставте наступні рядки в global.asax:

GlobalConfiguration.Configuration.Formatters.JsonFormatter.SerializerSettings.ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore;  
GlobalConfiguration.Configuration.Formatters.Remove(GlobalConfiguration.Configuration.Formatters.XmlFormatter);

Імпорт

using System.Data.Entity;

Інший випадок, коли я отримав цю помилку, коли запит на базу даних повернув нульове значення, але тип моделі користувача / перегляду був встановлений як нерегульований. Наприклад, змінюючи поле мого UserModel від intдо int?вирішена.

Це також відбувається, коли тип відповіді не є загальнодоступним! Я повернув внутрішній клас, коли використовував Visual Studio, щоб створити мені тип.

internal class --> public class

Хоча всі ці відповіді вище правильні, можна перевірити InnerException> ExceptionMessage .

Якщо це говорить щось подібне, "T екземпляр ObjectContext був розміщений і більше не може використовуватися для операцій, які потребують з'єднання. " Це може бути проблемою через поведінку EF за замовчуванням.

Призначаючи LazyLoadingEnabled = false у вашому конструкторі DbContext, це зробить трюк.

public class MyDbContext : DbContext
{
  public MyDbContext()
  {
    this.Configuration.LazyLoadingEnabled = false;
  }
}

Для більш детального читання про EagerLoading та LazyLoading поведінку EF див. Цю статтю MSDN .

У моєму випадку у мене було подібне повідомлення про помилку:

Тип "ObjectContent`1" не вдалося серіалізувати тіло відповіді для типу вмісту "application / xml; charset = utf-8 '.

Але коли я копаюсь глибше, то питання:

Введіть 'name.SomeSubRootType' з назвою договору даних 'SomeSubRootType: //schemas.datacontract.org/2004/07/WhatEverService' не очікується. Подумайте про використання DataContractResolver, якщо ви використовуєте DataContractSerializer або додайте до списку відомих типів будь-які типи, невідомі статично - наприклад, за допомогою атрибута KknownTypeAttribute або додавши їх до списку відомих типів, переданих у серіалізатор.

Те, як я вирішив, додавши KnownType.

[KnownType(typeof(SomeSubRootType))]
public partial class SomeRootStructureType

Це було вирішено натхненно на цю відповідь .

Довідка: https://msdn.microsoft.com/en-us/library/ms730167(v=vs.100).aspx

Visual Studio 2017 або 2019 з цього приводу абсолютно не продуманий, тому що сам Visual Studio вимагає, щоб вихід був у форматі json , тоді як формат Visual Studio - " XmlFormat" (config.Formatters.XmlFormatter) .

Visual Studio має робити це автоматично, а не створювати розробникам стільки проблем.

Щоб виправити цю проблему, перейдіть на веб-сторінку WebApiConfig.cs файла та додайте

var json = config.Formatters.JsonFormatter; json.SerializerSettings.PreserveReferencesHandling = Newtonsoft.Json.PreserveReferencesHandling.Objects; config.Formatters.Remove (config.Formatters.XmlFormatter);

після " config.MapHttpAttributeRoutes (); " у методі Регістр (HttpConfiguration config) . Це дозволить вашому проекту отримати вихід json.

У моєму випадку я вирішив відтворити базу даних. Я вніс деякі зміни в модель і запустив Update-Database в Console Package Manager, я отримав таку помилку:

"Оператор ALTER TABLE суперечить обмеженню FOREIGN KEY" FK_dbo.Activities_dbo.Projects_ProjectId ". Конфлікт стався в базі даних" TrackEmAllContext-20190530144302 ", таблиці" dbo.Projects ", стовпчику" Id ".

У разі: Якщо додавання коду до WebApiConfig.cs або Global.asax.cs не працює для вас:

.ToList();

Додайте функцію .ToList ().

Я випробував кожне рішення, але наступне працювало для мене:

var allShops = context.shops.Where(s => s.city_id == id)**.ToList()**;
return allShops;

Сподіваюся, це допомагає.

в моєму випадку це було виправлено, коли я видалив віртуальне ключове слово перед навігаційними властивостями, я маю на увазі таблиці довідки. тому я змінився

public virtual MembershipType MembershipType { get; set; }

до:

public MembershipType MembershipType { get; set; }