Creazione risposta JSON nel controller API Web

Question

In un progetto WebAPI, ho un controller che controlla lo stato di un prodotto, in base a un valore immesso dall'utente.

Diciamo che inseriscono "123" e la risposta dovrebbe essere "stato": 1, E un elenco di prodotti. Se inseriscono "321" lo "stato" è 0, E un elenco di prodotti.

La mia domanda è, come faccio a costruire una tale stringa corretta in un controller WebAPI.

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

Inoltre, questa uscita/risposta è considerata valida?

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

{ 
    "status": 0 
} 

Answer 1

Così qui sono le modifiche per il tuo post:

In primo luogo, si dovrebbe fare il vostro ritorno API JSON per impostazione predefinita quando si passare una richiesta text/html (è questo che stai cercando?), aggiungendo questa linea alla classe WebApiConfig:

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

In secondo luogo, ho cambiato il codice per restituire un oggetto reale, impersonando la risposta:

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

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

corpo del metodo:

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

Questo sarà risultati nel seguente esempio JSON:

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

Consiglio vivamente di non eseguire la formattazione manuale per tali cose e di basarsi su librerie incorporate e di terze parti. Altrimenti, reinventerai le cose già disponibili, testate e pronte per il lavoro.

Answer 2

Proprio come raderick accennato, non è necessario per creare la propria infrastruttura JSON personalizzato.

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

E nella vostra azione API, tornare in questo modo:

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

    return result; 
}