Come restituire oggetto JSON sul controller Web API

Question

Ho usato questo codice qui sotto sul mio controller asp.net per tornare oggetto JSON sul mio Ajax su javascript

public JsonResult myMethod() 
{ 
    // return a Json Object, you could define a new class 
    return Json(new 
    { 
     Success = true, //error 
     Message = "Success" //return exception 
    }); 
} 

Jquery-Ajax:

$.ajax({ 
    type: "POST", 
    url: url_ , 
    data: search, 
    success: function(data) { 
     //Show Json Properties from Controller (If Success == false show exception Message from controller) 
     if (data.Success) 
     { 
      alert(data.Message); //display success 
     } 
     else 
     { 
      alert(data.Message) //display exception 
     } 
    }, 
    error: function(XMLHttpRequest, textStatus, errorThrown) { 
     alert("error: " + XMLHttpRequest.responseText); 
    }, 
    dataType: 'json' 
}); 

Come si può fare su Web Api Controller?

Potete darmi alcuni esempi o url come riferimento.

Grazie e saluti

Answer 1

Se si crea da soli una nuova classe HttpContent per la consegna di JSON, come ...

public class JsonContent : HttpContent { 

    private readonly MemoryStream _Stream = new MemoryStream(); 
    public JsonContent(object value) { 

     Headers.ContentType = new MediaTypeHeaderValue("application/json"); 
     var jw = new JsonTextWriter(new StreamWriter(_Stream)); 
     jw.Formatting = Formatting.Indented; 
     var serializer = new JsonSerializer(); 
     serializer.Serialize(jw, value); 
     jw.Flush(); 
     _Stream.Position = 0; 

    } 
    protected override Task SerializeToStreamAsync(Stream stream, TransportContext context) { 
     return _Stream.CopyToAsync(stream); 
    } 

    protected override bool TryComputeLength(out long length) { 
     length = _Stream.Length; 
     return true; 
    } 
} 

allora si può fare,

 public HttpResponseMessage Get() { 
      return new HttpResponseMessage() { 
       Content = new JsonContent(new 
       { 
        Success = true, //error 
        Message = "Success" //return exception 
       }) 
      }; 
     } 

proprio come si fa con JsonResult.

Answer 2

ASP.NET Web API lavora con una filosofia diversa po '. Dovresti restituire solo un'entità (o un insieme di entità) e spetta al meccanismo di negoziazione del contenuto restituirlo al cliente nel formato che ha richiesto. Si può leggere di più su negoziazione dei contenuti qui:

• Everything you want to know about ASP.NET Web API content negotiation

Ovviamente si può by-pass del contenuto negiotiation restituendo un HttpResponseMessage. In questo caso è necessario serializzare l'oggetto in JSON da solo (i principi di questo approccio sono descritti anche nell'articolo menzionato sopra).

Answer 3

Dopo aver letto la risposta di tpeczek, la risposta di Darrel Miller e la loro conversazione di commento nella risposta di tpeczek, volevo ottenere maggiori indicazioni su quando o perché potrei voler utilizzare Web Api e il suo meccanismo di negoziazione del contenuto. Il collegamento di tpeczek è informativo e utile, ma ho trovato un paio di altri write-up che erano più orientati a confrontare l'uso di Web Api (e la sua negoziazione del contenuto) con azioni di controller MVC 4 semplici che restituiscono JsonResult. Ecco quelli che ho trovato utile per prendere una decisione del genere. Uno dei autore conclude che preferisce utilizzando semplici MVC 4 controller mentre l'altro autore preferisce utilizzare i controller Web Api:

Building a Public HTTP API for Data

Credo che ci sia una correzione necessaria in post dell'autore sopra. Lì egli afferma che,

" ... ogni metodo [Controller] che inizia con 'Get' è automaticamente associato al verbo GET. Suona grande? E ', ma anche significa che non è possibile avere due metodi il cui nome inizia con "Ottieni" nella della stessa classe di controller. "

Secondo this answer, è possibile infatti avere più metodi 'get' nella stesso controller se si specifica un attributo ActionName.Ora ecco il secondo post:

ASP.NET Web API vs. ASP.NET MVC “APIs”