Retourne JsonResult depuis Web Api sans ses propriétés

J'ai une Web API contrôleur et à partir de là je suis de retour d'un objet JSON à partir d'une action.

Je fais comme ceci:

public ActionResult GetAllNotificationSettings()
{
    var result = new List<ListItems>();
    //Filling the list with data here...

    //Then I return the list
    return new JsonResult { Data = result };
}

Mais de cette façon la JsonResult objet, y compris ses Data attribut est sérialisé en JSON. Ma dernière JSON qui est de retour par l'action ressemble à ceci:

{
    "ContentEncoding": null,
    "ContentType": null,
    "Data": {
        "ListItems": [
            {
                "ListId": 2,
                "Name": "John Doe"
            },
            {
                "ListId": 3,
                "Name": "Jane Doe"
            },
        ]
    },
    "JsonRequestBehavior": 1,
    "MaxJsonLength": null,
    "RecursionLimit": null
}

Je ne peux pas sérialiser cette chaîne JSON parce que le JsonResult objet ajouté toutes sortes d'autres propriétés. Je suis seulement intéressé dans ListItemsrien d'autre. Mais il ajoute automatiquement des choses comme: ContentTypeMaxJsonLength etc...

Maintenant cela ne fonctionne pas pour moi à cause de toutes les autres propriétés de la chaîne JSON...

var myList = JsonConvert.DeserializeObject<List<ListItems>>(jsonString);

Est-il un moyen d'envoyer un objet JSON à partir de l'action de sorte qu'il ne sera pas ajouter toutes les propriétés que je n'ai pas besoin?

source d'informationauteur Vivendi

  1. 41

    Comme quelqu'un qui a travaillé avec ASP.NET API pour environ 3 ans, je vous recommande de retourner un HttpResponseMessage à la place. N'utilisez pas le ActionResult ou IEnumerable!

    ActionResult est mauvais parce que comme vous l'avez découvert.

    Retour IEnumerable<> est mauvais parce que vous pouvez l'étendre plus tard et ajouter des en-têtes, etc.

    À l'aide de JsonResult est mauvais parce que vous devriez permettre à votre service pour être extensible et le soutien d'autres formats de réponse ainsi juste au cas où dans le futur; si vous voulez sérieusement à la limite, vous pouvez le faire en utilisant l'Action Attributs, pas dans l'action du corps.

    public HttpResponseMessage GetAllNotificationSettings()
{
    var result = new List<ListItems>();
    //Filling the list with data here...

    //Then I return the list
    return Request.CreateResponse(HttpStatusCode.OK, result);
}

    Dans mes tests, j'ai l'habitude d'utiliser les dessous de la méthode d'aide à extraire mes objets à partir de la HttpResponseMessage:

     public class ResponseResultExtractor
    {
        public T Extract<T>(HttpResponseMessage response)
        {
            return response.Content.ReadAsAsync<T>().Result;
        }
    }

var actual = ResponseResultExtractor.Extract<List<ListItems>>(response);

    De cette façon, vous avez atteint le ci-dessous:

    • Votre Action peut également renvoyer des Messages d'Erreur et les codes d'état comme 404 not found donc dans la façon décrite ci-dessus, vous pouvez facilement gérer.
    • Votre Action n'est pas limité à du JSON, mais prend en charge JSON selon la demande du client préférences et les paramètres dans le module de Formatage.

    Regardez ceci: http://www.asp.net/web-api/overview/formats-and-model-binding/content-negotiation

  2. 12

    Lors de l'utilisation de WebAPI, il suffit de retourner l'Objet plutôt que spécifiquement retour Json, que l'API soit de retour JSON ou XML en fonction de la demande.

    Je ne suis pas sûr de savoir pourquoi votre WebAPI est au retour d'une ActionResult, mais je voudrais changer le code pour quelque chose comme;

    public IEnumerable<ListItems> GetAllNotificationSettings()
{
    var result = new List<ListItems>();
    //Filling the list with data here...

    //Then I return the list
    return result;
}

    Ce résultat JSON si vous appelez d'un code AJAX.

    P. S
    WebAPI est censé être paisible, de sorte que votre Contrôleur doit être appelé ListItemController et votre Méthode doit être appelée uniquement Get. Mais c'est pour un autre jour.

  3. 9

    J'ai eu un problème similaire (différences étant que je voulais renvoyer un objet qui a déjà été converti en chaîne json et mon contrôleur obtenir renvoie une IHttpActionResult)

    Voici comment je l'ai résolu. D'abord, j'ai déclaré une classe utilitaire

    public class RawJsonActionResult : IHttpActionResult
{
    private readonly string _jsonString;

    public RawJsonActionResult(string jsonString)
    {
        _jsonString = jsonString;
    }

    public Task<HttpResponseMessage> ExecuteAsync(CancellationToken cancellationToken)
    {
        var content = new StringContent(_jsonString);
        content.Headers.ContentType = new MediaTypeHeaderValue("application/json");
        var response = new HttpResponseMessage(HttpStatusCode.OK) { Content = content };
        return Task.FromResult(response);
    }
}

    Cette classe peut ensuite être utilisé dans votre contrôleur. Voici un exemple simple

    public IHttpActionResult Get()
{
    var jsonString = "{\"id\":1,\"name\":\"a small object\" }";
    return new RawJsonActionResult(jsonString);
}
  4. -2
    return JsonConvert.SerializeObject(images.ToList(), Formatting.None, new JsonSerializerSettings { PreserveReferencesHandling = PreserveReferencesHandling.None, ReferenceLoopHandling = ReferenceLoopHandling.Ignore });


using Newtonsoft.Json;