C# REST API polymorpher Rückgabetyp

Question

Ich habe Datenverträge geschaffen, wie unten mit Vererbung: -

[DataContract(Name = "Animal")] 
public class Animal { ... } 

[DataContract(Name = "Dog ")] 
public class Dog : Animal { // Has some Dog specific member properties } 

[DataContract(Name = "Cat ")] 
public class Cat : Animal { // Has some Cat specific member properties } 

Und ich bin mit ASP.NET WebAPI einen REST-API zur Verfügung zu stellen wie:

[HttpGet] 
public Task<Animal> Get(string type) 
{ 
    switch(type) 
    { 
     case "dog": 
      Dog dog = GetDogDetails(); 
      return Task.FromResult(dog); 
      break; 

     case "cat": 
      Cat cat = GetCatDetails(); 
      return Task.FromResult(cat); 
      break: 
    } 
} 

Ich kann die jeweiligen Tierarten nicht zurückgeben. Ich erhalte den folgenden Fehler: - "Hund kann nicht implizit in Tier konvertiert werden".

Auch ist diese polymorphe Antwort eine gute Sache wie REST API-Standards.

Answer 1

Der Grund, warum Sie diesen Fehler erhalten, ist, weil Sie eine Task<T> zurückgeben und Aufgabe ist nicht kovariant. Das heißt, obwohl DogAnimal ist, ist Task<Dog> nicht Task<Animal>.

Was können Sie tun?

1. Ändern Sie Ihren Code

   case "dog": 
       Animal dog = GetDogDetails(); 
       return Task.FromResult(dog); 
       break; 
   

Sie zu sein, obwohl Hunde spezifischen Eigenschaften verlieren.

2. Nutzen Sie Task<IHttpActionResult> und geben Sie Ok(yourObject) zurück.

   [HttpGet] 
   public async Task<IHttpActionResult> Get(string type) 
   { 
       switch(type) 
       { 
        case "dog": 
         Dog dog = GetDogDetails(); 
         return Ok(dog); 
         break; 
   
       ... 
       } 
   } 
   

ich glaube, Sie den zweiten Weg gehen sollte.

Auf eine zweite Anmerkung sehe ich keinen Grund, async/await hier zu verwenden. Warum würden Sie Task.FromResult verwenden? Wenn Ihre GetDogDetails Methode async ist, betrachten Sie awaiting es. Ich denke nicht, dass Sie sich in Ihrem aktuellen Code Gedanken um Aufgaben machen sollten.

Also is this polymorphic response a good thing as per REST API standards.

Ich weiß nicht über formale Standards, aber im Allgemeinen ist es in Ordnung, dass einige Objekte bestimmte Eigenschaften haben und andere nicht. Stellen Sie sich zum Beispiel ein Zahlungssystem vor, das ein abstraktes Ereignis zurückgibt, zu dem möglicherweise eine Rechnung gehört.