.NET WebAPI серіалізація k_BackingField Nastiness

Коли я серіалізую наступне:

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

Я отримую цей огидний безлад:

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

Що дає? Як я можу зробити це гарненьким? Відповіді JSON також містять k_BackingField

За замовчуванням вам не потрібно використовувати ні , [Serializable]ні [DataContract]для роботи з Web API.

Просто залиште свою модель такою, яка є, і веб-API буде серіалізувати всі загальнодоступні властивості для вас.

Тільки якщо ви хочете мати більше контролю над тим, що входить, ви потім прикрасите свій клас [DataContract]та властивості, які потрібно включити [DataMember](оскільки і DCS, і JSON.NET ресепсують ці атрибути).

Якщо з якихось причин вам потрібен [Serializable]ваш клас (тобто ви з якихось причин його серіалізуєте в потік пам'яті, роблячи глибокі копії тощо), тоді вам доведеться використовувати обидва атрибути спільно, щоб запобігти іменам полів резервного копіювання:

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

Існує більш загальне рішення: ви можете налаштувати серіалізатор Json на ігнорування [Serializable]атрибута, так що вам не доведеться змінювати атрибути у своїх класах.

Ви повинні змінити цю конфігурацію під час запуску програми, тобто у Application_Startподії Global.asax :

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

Ви також можете внести інші зміни в серіалізацію Json, наприклад, вказати формати для серіалізації дат та багато іншого.

Це стосуватиметься лише серіалізації JSON веб-API. Інші серіалізації в додатку (веб-API XML серіалізація, MVC JsonResult ...) не вплинуть на це налаштування.

Спробуйте використовувати DataContract замість Serializable для позначення вашого класу. Детальніше про те, чому, дивіться на цю хорошу публікацію в блозі про серіалізацію автоматичних властивостей.

Атрибути [DataContract] у мене не працювали, тому це не було варіантом.

XmlSerializer ігнорує [XmlAttribute] у WebApi

Вищезгадана резолюція вирішила це для мене.

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