RestSharp-Serialisierung zu JSON, Objekt verwendet SerializeAs-Attribut nicht wie erwartet

Question

Ich verwende RestSharp (Version 104.4 über NuGet), um Aufrufe an einen Rest-Webdienst zu senden. Ich habe eine Reihe von Objekten (POCO) entworfen, die mit Ressourcen in der API übereinstimmen. Die Objekteigenschaftsnamen meiner Objekte stimmen jedoch nicht mit denen überein, die vom Restdienst beim Posten von Daten erwartet werden. Daher möchte ich sie "transformieren", wenn ich eine Anfrage an den Rest-Dienst mache, damit sie mit der Übereinstimmung übereinstimmen. Ich habe gelesen, dass das Hinzufügen von SerializeAs Attribut (mit einem Namen angegeben) auf meiner POCO-Eigenschaft wird sie korrekt serialisieren, aber es wird nicht.

Mein POCO

Imports RestSharp.Serializers 

<Serializable(), SerializeAs(Name:="ApiMember")> 
Public Class ApiMember 
    <SerializeAs(Name:="id")> 
    Public Property Id As Integer? 

    <SerializeAs(Name:="email")> 
    Public Property EmailAddress As String 

    <SerializeAs(Name:="firstname")> 
    Public Property Firstname As String 

    <SerializeAs(Name:="lastname")> 
    Public Property Lastname As String 
End Class 

Mein Aufruf an die API

Dim request As RestRequest = New RestRequest(Method.POST) 
Dim member As ApiMember = new ApiMember() 

member.EmailAddress = "me@example.com" 

request.Resource = "members" 
request.RequestFormat = DataFormat.Json 
request.AddBody(member) 

Dim client As RestClient = New RestClient() 
client.BaseUrl = "http://url.com" 
client.Authenticator = New HttpBasicAuthenticator("username", "password") 
client.Execute(Of ApiGenericResponse)(request) 

Was geschrieben endet als

{"Id":null,"EmailAddress":"me@example.com","Firstname":null,"Lastname":null} 

Nein tice der Name der Eigenschaften stimmt nicht mit denen ich in SerializeAs angegeben (Großbuchstaben, Name der EmailAddress)

Fehle ich etwas?

Answer 1

Dies ist für @MaxiWheat und alle anderen, die daran interessiert sind, JSON.NET als JSON-Serializer in einer RestSharp-Anfrage zu verwenden. Grundsätzlich habe ich den Ansatz beschrieben in this blog post by Patrick Riley:

// create the request 
var request = new RestRequest(yourUrlHere, Method.POST) { RequestFormat = DataFormat.Json }; 

// attach the JSON.NET serializer for RestSharp 
restRequest.JsonSerializer = new RestSharpJsonNetSerializer(); 

und die RestSharpJsonNetSerializer ist eine Implementierung (weniger als 100 Zeilen Code) von den JSON.NET Jungs (John Sheehan), dass can be found on their Github pages

Mit diesem Setup , meine Probleme gingen weg und ich konnte ein korrektes DTO mit netten CamelCase-Eigenschaften haben, während das serialisierte JSON sie in allen "Kleinbuchstaben" verwendet.

Answer 2

In RestSharp 104.4 verwendet der Standardwert JsonSerializer nicht das Attribut [SerializeAs], wie aus der Überprüfung der source code ersichtlich ist.

Eine Abhilfe hierfür ist ein benutzerdefinierten Serializer zu erstellen, die die Json.NET verwendet JsonSerializer (ein gutes Beispiel ist here) und dann Eigenschaften mit dem [JsonProperty] Attribute schmückt, etwa so:

<JsonProperty("email")> 
Public Property EmailAddress As String 

Answer 3

RestSharp Anwendungen SimpleJson. Diese Bibliothek kennt oder respektiert das [SerializeAs] Attribut (is XML-only anyway) nicht, es ist nur outputs the POCO's property name, es sei denn, es ist mit #SIMPLE_JSON_DATACONTRACT definiert, dann können Sie das Attribut [DataContract] verwenden, um Eigenschaften umzubenennen.

Ihre Optionen scheinen also zu sein, die SimpleJson-Bibliothek mit dem Attribut [DataContract(Name="lowercasepropertyname")] neu zu definieren und zu dekorieren oder einen benutzerdefinierten Serializer zu erstellen, der einen JSON-Serializer verwendet, der andere Attribute berücksichtigt, wie in @ Ryan's Antwort vorgeschlagen.

Answer 4

Ich bin auf dieses Problem gestoßen, und löste das etwas anders als oben, wollte es hier notieren.

Wir haben eine factory Klasse, die alle unsere Anfragen erstellt. Sieht aus wie die folgende

public IRestRequest CreatePutRequest<TBody>(string resource, TBody body) 
{ 
    var request = new RestRequest(resource) 
    { 
     Method = Method.PUT, 
    }; 

    request.AddParameter("application/json", Serialize(body), ParameterType.RequestBody); 
    return request; 
} 

als vielmehr nutzen die AddJsonBody und AddBody Methoden gegen den Antrag, die beide die Serialisierung verursachen, benutzte ich AddParameter, die das Objekt hinzufügen, werden Sie in ohne Serialisierung passieren. Ich habe eine Methode namens Serialise erstellt, die JSON.net verwendet, um unsere Klasse zu serialisieren. Diese

private object Serialize<T>(T item) 
{ 
    return JsonConvert.SerializeObject(item); 
} 

dann können wir JSON.net ‚s JsonProperty Anmerkung über Ihre propertys verwenden. Hier ist ein Beispiel -

public class Example 
{ 

    [JsonProperty(PropertyName = "name")] 
    public string Name { get; set; } 

    [JsonProperty(PropertyName = "created")] 
    public DateTime Created { get; set; } 

    [JsonProperty(PropertyName = "updated")] 
    public DateTime Updated { get; set; } 

}