Nie udało się serializować odpowiedzi w internetowym interfejsie API za pomocą Json

Pracuję z ASP.NET MVC 5 Web Api. Chcę skonsultować się ze wszystkimi moimi użytkownikami.

Napisałem api/usersi otrzymuję to:

„Nie udało się serializować treści odpowiedzi dla typu„ ObjectContent ”1 dla typu zawartości„ application / json; charset = utf-8 ”.

W WebApiConfig dodałem już te linie:

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

Ale to nadal nie działa.

Moja funkcja zwracania danych jest następująca:

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

Jeśli chodzi o zwracanie danych z powrotem do konsumenta z Web Api (lub jakiejkolwiek innej usługi sieciowej w tym zakresie), zdecydowanie odradzam przekazywanie podmiotów pochodzących z bazy danych. O wiele bardziej niezawodne i łatwiejsze w utrzymaniu jest używanie modeli, w których masz kontrolę nad wyglądem danych, a nie bazy danych. W ten sposób nie musisz zbytnio bawić się elementami formatującymi w WebApiConfig. Możesz po prostu utworzyć model użytkownika, który ma modele potomne jako właściwości i pozbyć się pętli odwołań w zwracanych obiektach. To sprawia, że ​​serializator jest znacznie szczęśliwszy.

Ponadto nie ma potrzeby usuwania elementów formatujących lub obsługiwanych typów multimediów, zazwyczaj jeśli w żądaniu określasz tylko nagłówek „Accepts”. Zabawa z tymi rzeczami może czasami sprawić, że sytuacja będzie bardziej zagmatwana.

Przykład:

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

Jeśli pracujesz z EF, oprócz dodania poniższego kodu na Global.asax

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

Nie zapomnij zaimportować

using System.Data.Entity;

Następnie możesz zwrócić własne modele EF

Proste!

Podana prawidłowa odpowiedź jest jednym ze sposobów, jednak jest to przesada, gdy można to naprawić za pomocą jednego ustawienia konfiguracji.

Lepiej użyć go w konstruktorze dbcontext

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

Błąd interfejsu API sieci Web Asp.Net: dla typu „ObjectContent” 1 nie można serializować treści odpowiedzi dla typu zawartości „application / xml”; charset = utf-8 '

Dodaj ten kod global.asaxponiżej w Application_Start:

Aktualizuj z .Ignoredo .Serialize. To musi działać.

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();
    }
}

Nie podoba mi się ten kod:

foreach(var user in db.Users)

Alternatywnie można zrobić coś takiego, co u mnie zadziałało:

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

                         });

return listOfUsers.ToList();

Skończyło się jednak na rozwiązaniu Lucasa Rosellego.

Aktualizacja: Uproszczone przez zwrócenie anonimowego obiektu:

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

return listOfUsers.ToList();

Rozwiązałem to używając tego kodu do pliku WebApiConfig.cs

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

Istnieje również ten scenariusz, który generuje ten sam błąd:

W przypadku, gdy powrót jest List<dynamic>metodą api sieci web

Przykład:

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; }
}

Dlatego w tym scenariuszu użyj [KnownTypeAttribute] w klasie zwracanej (wszystkich) w następujący sposób:

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

To działa dla mnie!

Dodanie tego do Application_Start()metody Global.asaxpliku powinno rozwiązać problem

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

METODA 2: [Niezalecane]
Jeśli pracujesz z EntityFramework, możesz wyłączyć serwer proxy w konstruktorze klasy DbContext. UWAGA: ten kod zostanie usunięty, jeśli zaktualizujesz model

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

Mój osobisty ulubiony: po prostu dodaj poniższy kod do App_Start/WebApiConfig.cs. Spowoduje to domyślnie zwrócenie pliku json zamiast XML, a także zapobiegnie wystąpieniu błędu. Nie ma potrzeby edycji, Global.asaxaby usunąć XmlFormatteritp.

Nie udało się serializować treści odpowiedzi dla typu „ObjectContent” 1 dla typu zawartości „application / xml”; charset = utf-8

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

Użyj AutoMapper ...

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

Użyj następującej przestrzeni nazw:

using System.Web.OData;

Zamiast :

using System.Web.Http.OData;

U mnie to zadziałało

Dodaj poniższą linię

this.Configuration.ProxyCreationEnabled = false;

Dwa sposoby użycia ProxyCreationEnabledjako false.

1. Dodaj go do DBContextConstructor

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

LUB

2. Dodaj linię wewnątrz Getmetody

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

Rozwiązanie, które zadziałało dla mnie:

1. Użyj [DataContract]dla klasy i [DataMember]atrybutów dla każdej właściwości do serializacji. To wystarczy, aby otrzymać wynik Json (np. Ze skrzypka).

2. Aby uzyskać serializację XML, napisz w Global.asaxtym kodzie:

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

3. Przeczytaj ten artykuł, pomógł mi zrozumieć serializację: https://www.asp.net/web-api/overview/formats-and-model-binding/json-and-xml-serialization

Aby dodać do odpowiedzi Jensendpa:

Przekazałbym jednostkę do modelu utworzonego przez użytkownika i użyłbym wartości z tej jednostki, aby ustawić wartości w nowo utworzonym modelu. Na przykład:

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;
   }
}

Następnie zmień typ zwrotu na: IEnumerable<UserInformation>

Zasadniczo dodaję jedną linię, którą są

• entity.Configuration.ProxyCreationEnabled = false;

do 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);
            }
        }
    }
}

Użyj [Serializable] dla klasy:

Przykład:

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

U mnie zadziałało!

Będziesz musiał zdefiniować Serializer Formatter w WebApiConfig.cs dostępnym w folderze App_Start, takim jak

Dodawanie config.Formatters.Remove (config.Formatters.XmlFormatter); // który dostarczy Ci dane w formacie JSON

Dodanie config.Formatters.Remove (config.Formatters.JsonFormatter); // który dostarczy Ci dane w formacie XML

Po prostu umieść następujące wiersze w global.asax:

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

Import

using System.Data.Entity;

Innym przypadkiem, w którym otrzymałem ten błąd, było to, że moje zapytanie do bazy danych zwróciło wartość null, ale mój typ modelu użytkownika / widoku został ustawiony jako niepodlegający wartości null. Na przykład zmiana mojego pola UserModel z intna int?rozwiązane.

Dzieje się tak również, gdy typ odpowiedzi nie jest publiczny! Zwróciłem klasę wewnętrzną, ponieważ użyłem programu Visual Studio do wygenerowania typu.

internal class --> public class

Chociaż wszystkie powyższe odpowiedzi są poprawne, warto sprawdzić InnerException> ExceptionMessage .

Jeśli mówi coś takiego: „Instancja ObjectContext została usunięta i nie może być już używana do operacji wymagających połączenia. ”. Może to być problem z powodu domyślnego zachowania EF.

Przypisanie LazyLoadingEnabled = false w konstruktorze DbContext załatwi sprawę.

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

Aby uzyskać bardziej szczegółowe informacje na temat zachowania EF w trybie EagerLoading i LazyLoading, zapoznaj się z tym artykułem w witrynie MSDN .

W moim przypadku miałem podobny komunikat o błędzie:

Nie udało się serializować treści odpowiedzi dla typu „ObjectContent” 1 dla typu zawartości „application / xml”; charset = utf-8 '.

Ale kiedy głębiej się w to zagłębiłem, problem był następujący:

Wpisz „name.SomeSubRootType” z nazwą kontraktu danych „SomeSubRootType: //schemas.datacontract.org/2004/07/WhatEverService” nie jest oczekiwany. Rozważ użycie DataContractResolver, jeśli używasz DataContractSerializer lub dodaj dowolne typy nieznane statycznie do listy znanych typów - na przykład przy użyciu atrybutu KnownTypeAttribute lub dodając je do listy znanych typów przekazanych do serializatora.

Sposób, w jaki rozwiązałem, dodając KnownType.

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

Zostało to rozwiązane zainspirowane tą odpowiedzią .

Źródła: https://msdn.microsoft.com/en-us/library/ms730167(v=vs.100).aspx

Program Visual Studio 2017 lub 2019 jest w tej kwestii całkowicie bezmyślny, ponieważ sam program Visual Studio wymaga, aby dane wyjściowe były w formacie json , podczas gdy domyślnym formatem programu Visual Studio jest „ XmlFormat” (config.Formatters.XmlFormatter) .

Visual Studio powinno robić to automatycznie, zamiast sprawiać programistom tyle problemów.

Aby rozwiązać ten problem, przejdź do pliku WebApiConfig.cs i dodaj

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

po „ config.MapHttpAttributeRoutes (); ” w metodzie Register (HttpConfiguration config) . Umożliwiłoby to projektowi wygenerowanie danych wyjściowych json.

W moim przypadku rozwiązałem odtworzenie bazy danych. Dokonałem pewnych zmian w modelu i uruchomiłem Update-Database w konsoli Menedżera pakietów. Otrzymałem następujący błąd:

„Instrukcja ALTER TABLE spowodowała konflikt z ograniczeniem FOREIGN KEY„ FK_dbo.Activities_dbo.Projects_ProjectId ”. Konflikt wystąpił w bazie danych„ TrackEmAllContext-20190530144302 ”, tabela„ dbo.Projects ”, kolumna„ Id ”.”

W przypadku: Jeśli dodanie kodu do WebApiConfig.cs lub Global.asax.cs nie działa dla Ciebie:

.ToList();

Dodaj funkcję .ToList ().

Wypróbowałem każde rozwiązanie, ale działały dla mnie następujące:

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

Mam nadzieję, że to pomoże.

w moim przypadku zostało to naprawione, gdy usunąłem słowo kluczowe virtual przed właściwościami nawigacji, mam na myśli tabele referencyjne. więc się zmieniłem

public virtual MembershipType MembershipType { get; set; }

do:

public MembershipType MembershipType { get; set; }