Serializzazione .NET WebAPI k_BackingField Nastiness

Quando serializzo quanto segue:

[Serializable]
public class Error
{

    public string Status { get; set; }
    public string Message { get; set; }
    public string ErrorReferenceCode { get; set; }
    public List<FriendlyError> Errors { get; set; }
}

Ottengo questo disordine disgustoso:

<ErrorRootOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance"   xmlns="http://schemas.datacontract.org/2004/07/Printmee.Api">
<_x003C_Errors_x003E_k__BackingField>
An exception has occurred. Please contact printmee support
</_x003C_Errors_x003E_k__BackingField>
<_x003C_LookupCode_x003E_k__BackingField>988232ec-6bc9-48f3-8116-7ff7c71302dd</_x003C_LookupCode_x003E_k__BackingField>
</ErrorRootOfstring>

Cosa succede? Come posso renderlo carino? Le risposte JSON contengono anche k_BackingField

Per impostazione predefinita, non è necessario utilizzare né [Serializable]né [DataContract]lavorare con l'API Web.

Lascia il tuo modello così com'è e l'API Web serializzerà tutte le proprietà pubbliche per te.

Solo se vuoi avere un maggiore controllo su ciò che è incluso, allora decori la tua classe con [DataContract]e le proprietà da includere [DataMember](perché sia ​​DCS che JSON.NET rispettano questi attributi).

Se per qualche motivo, hai bisogno del [Serializable]sulla tua classe (cioè lo stai serializzando in un flusso di memoria per qualche motivo, eseguendo copie profonde ecc.), Allora devi usare entrambi gli attributi insieme per prevenire i nomi dei campi di supporto:

[Serializable]
[DataContract]
public class Error
{
    [DataMember]
    public string Status { get; set; }
    [DataMember]
    public string Message { get; set; }
    [DataMember]
    public string ErrorReferenceCode { get; set; }
    [DataMember]
    public List<FriendlyError> Errors { get; set; }
}

C'è una soluzione più generale: puoi configurare Json Serializer per ignorare l' [Serializable]attributo, in modo da non dover modificare gli attributi nelle tue classi.

È necessario apportare questa modifica alla configurazione all'avvio dell'applicazione, ovvero Application_Startnell'evento Global.asax :

var serializerSettings =
  GlobalConfiguration.Configuration.Formatters.JsonFormatter.SerializerSettings;
var contractResolver =
  (DefaultContractResolver)serializerSettings.ContractResolver;
contractResolver.IgnoreSerializableAttribute = true;

Puoi anche apportare altre modifiche alla serializzazione Json, come specificare i formati per la serializzazione delle date e molte altre cose.

Ciò si applicherà solo alla serializzazione JSON dell'API Web. Le altre serializzazioni nell'app (serializzazione XML dell'API Web, MVC JsonResult ...) non saranno interessate da questa impostazione.

Prova a utilizzare DataContract invece di Serializable per contrassegnare la tua classe. Per maggiori dettagli sul perché, guarda questo buon post sul blog sulla serializzazione delle proprietà automatiche.

Gli attributi [DataContract] non funzionavano per me, quindi non era un'opzione.

XmlSerializer ignora [XmlAttribute] in WebApi

La risoluzione di cui sopra lo ha risolto per me.

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