JSON-Antwort im Web-API-Controller erstellen

Question

In einem WebAPI-Projekt habe ich einen Controller, der den Status eines Produkts basierend auf einem vom Benutzer eingegebenen Wert überprüft.

Nehmen wir an, sie geben "123" und die Antwort sollte "Status" sein: 1, und eine Liste von Produkten. Wenn sie "321" eingeben, lautet der "Status" 0 und eine Liste von Produkten.

Meine Frage ist, wie ich eine solche Zeichenfolge in einem WebAPI-Controller korrekt erstellen.

[Route("{value:int}")] 
public string GetProducts(int value) 
{ 
    var json = ""; 
    var products = db.Products; 
    if (products.Any()) 
    { 
     foreach (var s in products) 
     { 
      ProductApi product = new ProductApi(); 
      product.Name = s.Name; 
      json += JsonConvert.SerializeObject(supplier); 
     } 
    } 

    var status = db.Status; 
    if (status.Any()) 
    { 
     json += "{status:1}"; 
    } 
    else 
    { 
     json += "{status:0}"; 
    } 

    return json; 
} 

public class ProductApi 
{ 
    public string Name { get; set; } 
} 

Wird diese Ausgabe/Antwort auch als gültig betrachtet?

[ 
    { 
     "id":1, 
     "name":"product name" 
    }, 
    { 
     "id":2, 
     "name":"product name 2" 
    }, 
    { 
     "id":3, 
     "name":"product name 3" 
    } 
] 

{ 
    "status": 0 
} 

Answer 1

Also hier sind die Änderungen für Ihren Beitrag:

Zunächst sollten Sie Ihre api Rückkehr Json standardmäßig, wenn Sie passieren eine text/html Anfrage (wird dieser Sie suchen?), das Hinzufügen dieser Zeile in WebApiConfig Klasse:

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

Zweitens änderte ich den Code ein reales Objekt zurückzukehren, Ihre Antwort Identitätswechsel:

public class ProductApiCollection 
{ 
    public ProductApi[] Products { get; set; }  
    public byte Status { get; set; } 
} 

public class ProductApi 
{ 
    public string Name { get; set; } 
} 

Methode Körper:

public ProductApiCollection Get() 
{ 
    var result = new ProductApiCollection(); 
    var dbProducts = db.Products; 
    var apiModels = dbProducts.Select(x => new ProductApi { Name = x.Name }).ToArray(); 
    result.Products = apiModels; 

    var status = db.Status.Any() ? 1 : 0; 
    result.Status = status; 

    return result; 
} 

Dies wird Ergebnisse im folgenden Beispiel json:

{ 
    "Products": [ 
    { 
     "Name": "Pork" 
    }, 
    { 
     "Name": "Beef" 
    }, 
    { 
     "Name": "Chicken" 
    }, 
    { 
     "Name": "Salad" 
    } 
    ], 
    "Status": 1 
} 

Ich rate Ihnen dringend, keine manuelle Formatierung für solche Dinge zu machen, und verlassen Sie sich auf integrierte und 3rd-Party-Bibliotheken. Ansonsten erfindest du die Dinge neu, die bereits verfügbar sind, getestet und bereit zu arbeiten.

Answer 2

Wie raderick erwähnt, brauchen Sie nicht Ihre eigene benutzerdefinierte JSON-Infrastruktur zu erstellen.

public class ProductApi 
{ 
    public int Id {get;set;} 
    public string Name { get; set; } 
} 

public class ResponseDTO 
{ 
    public int Status {get;set;} 
    public List<ProductApi> { get; set; } 
} 

Und in Ihrer API-Aktion, wie dies zurück:

[Route("{value:int}")] 
public ResponseDTO GetProducts(int value) 
{ 
    ResponseDTO result = ...// construct response here 

    return result; 
}