Comment retourner un objet Json sur le Web API Contrôleur

J'ai utilisé ce code ci-dessous sur mon asp.net contrôleur pour revenir objet Json sur mon Ajax 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'
});

Comment cela peut-il être fait sur le Web Api Contrôleur?

Pouvez-vous me donner des exemples ou l'url de référence.

Merci et Salutations

InformationsquelleAutor BizApps | 2013-01-09
  1. 25

    Si vous créez vous-même un nouveau HttpContent classe pour la fourniture de JSON, comme...

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

    Alors vous pouvez le faire,

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

    comme vous le feriez avec JsonResult.

    • Pourquoi ne pas utiliser la sérialisation par défaut le comportement de l'API Web et il suffit de retourner votre type de directement et de laisser le cadre de poignée de la sérialisation?
    • Parce que parfois, il est très important de contrôler votre format de câble. Laisser un sérialiseur de prendre les décisions pour vous peut vous rendre dépendant de ce processus et de sa configuration. C'est moins une question pour le Json que XML, mais il peut encore être un problème.
    • Fonctionne très bien. Merci!
    • Il pourrait être judicieux de l'inclure dans cette réponse, un exemple de la façon dont on pourrait utiliser la "sérialisation par défaut de comportement" (je suis moi-même pas tout à fait certain, c'est Request.CreateResponse(....,myJsonObject)?)
    • C'est l'une des quelques façons. Vous pouvez également juste de retour d'un natif CLR objet à partir de la méthode de contrôleur et un formateur va sérialiser.
    • Ah, je vois. De la recherche, il semble que c'est une autre question en elle-même (été répondu here)
    • jQuery.l'ajax succès de rappel ne semble pas être en mesure de traiter cela comme un objet JSON. Le résultat semble être la totalité de la réponse de l'objet, y compris les en-têtes. Aussi pourquoi ne _Stream besoin en lecture seule?

    InformationsquelleAutor Darrel Miller
  2. 30

    ASP.NET Web API travaille avec un peu différente de la philosophie. Vous devez retourner seulement une entité (ou les entités) et c'est à la négociation de contenu mécanisme à retourner au client dans le format qu'il a demandé. Vous pouvez lire plus au sujet de la négociation de contenu ici:

    Bien sûr, vous pouvez contourner le contenu negiotiation en retournant un HttpResponseMessage. Dans ce cas, yo besoin de sérialiser l'objet en JSON vous-même (les bases de cette approche sont également décrites dans l'article mentionné ci-dessus).

    • À mon avis, qui n'est ni la philosophie de l'API Web ou le contenu de la négociation. Retour des types arbitraires est un style particulier de l'utilisation de l'API web, c'est possible, mais qui a beaucoup de pièges potentiels. La négociation de contenu est le mécanisme par lequel le client déclare que les types de médias, il est en mesure de traiter et le serveur tente de tenir compte des préférences du client. L'accent est très différent que de dire que le client demande le format X. Vous pouvez également faire conneg et retour HttpResponseMessage.
    • En général je suis d'accord, et je ne l'aurais pas écrit cette réponse maintenant, comme je l'ai fait il y a 4 mois - bon que le vôtre est le reconnus. Je crois que certaines personnes trouvent utile de la mine en raison principalement du contenu disponible sous le lien.
    • J'espère que plus de gens vont réaliser une fois qu'ils commencent à l'aide de WebAPI que l'appel initial de juste retour des objets n'est pas aussi utile qu'elle s'affiche.
    • À la lumière de l'Api Web 2 et ses IHttpActionResult, tpeczek réponse semble être la bonne.
    InformationsquelleAutor tpeczek
  3. 10

    Après la lecture de tpeczek réponse, Darrel Miller réponse, et leur commentaire conversation en tpeczek réponse, je voulais obtenir plus de conseils sur quand ou pourquoi je veuille utiliser l'Api Web et de son contenu mécanisme de négociation. tpeczek du lien est instructif et utile, mais j'en ai trouvé deux autres write-ups qui étaient plus orientées à la comparaison de l'utilisation de l'Api Web (et ses de la négociation de contenu) avec, par exemple, de la plaine MVC 4 actions de contrôleur que le retour JsonResult. Voici celles que j'ai trouvé utile de prendre une telle décision. L'auteur conclut qu'il préfère à l'aide de la plaine MVC 4 contrôleurs tandis que l'autre auteur préfère utiliser des contrôleurs d'Api Web:

    la Construction d'un Public de l'API HTTP pour les Données

    Je crois qu'il existe une correction nécessaire au-dessus de l'auteur du post. Il y mentionne que,

    "...tous les [Controller] méthode qui commence par " Get " est automatiquement
    associé au verbe GET. Ce son est-il grand? Il est, mais il a également
    signifie que vous ne pouvez pas avoir les deux méthodes dont le nom commence par " Get " dans
    le même contrôleur de classe."

    Selon cette réponse, vous pouvez en effet avoir plusieurs 'Get' méthodes dans le même contrôleur si vous spécifiez un ActionName attribut. Maintenant, voici le deuxième post:

    ASP.NET l'API Web vs ASP.NET MVC “Api”

    InformationsquelleAutor Jason Frank