ASP.NET WebAPI: Comment contrôler la chaîne de contenu retourné au client?

Dans WebAPI, dis-je retourner une chaîne enroulée dans une réponse HTTP:

return Request.CreateResponse(HttpStatusCode.BadRequest, "Line1 \r\n Line2");

Lors de l'invocation de cette action à partir de jQuery, le texte de la réponse est traitée avant d'être retourné. Ainsi, dans le xhr, j'obtiens quelque chose comme ceci:

function success(xhr) {
    alert(xhr.responseText); //alerts ""Line1 \\r\\n Line2""
}

En d'autres termes, la chaîne est enveloppé dans des guillemets, caractères spéciaux obtenir échappé de sorte qu'elles apparaissent dans la sortie (réelles d'alerte est "Ligne1 \r\n Line2", de sorte que les retours à la ligne ne sont pas conservés, mais plutôt codé et illustré dans le texte de la réponse).

Je peux contourner ce problème en supprimant les guillemets et de remplacer les retours à la ligne sur le client comme suit:

var responseText = xhr.responseText.substr(1, xhr.responseText - 2)
    .replace('\\r', '\r').replace('\\n', '\n');

Mais est-il une façon de dire WebAPI la façon de chaîne de format des réponses? Par exemple, de ne pas les emballer dans des guillemets, et convertir les caractères échappés?

InformationsquelleAutor danludwig | 2012-10-29
  1. 18

    Cela se produit parce que votre contrôleur est de retour JSON dans lequel les valeurs de chaîne sont cités.

    Une solution simple consiste à analyser les responseText JSON et puis vous pouvez utiliser la valeur comme prévu:

    $.ajax("/api/values/10", {
    error: function (xhr) {
        var error = JSON.parse(xhr.responseText);
        $("textarea").val(error);
    }
});

    Cette interprète correctement les sauts de ligne/retours chariot.

    Sinon, vous pouvez spécifier le text/plain type de support dans votre contrôleur:

    return Request.CreateResponse(
    HttpStatusCode.BadRequest, 
    "Line1 \r\n Line2", "text/plain");

    API Web va alors essayer et de charger un type de support approprié formateur pour text/plain qui, malheureusement, n'existe pas OOTB. Vous en trouverez une dans WebApiContrib.

    • Merci c'est exactement ce que je cherchais. Une dernière question, quel est le meilleur: Pour ajouter le type de média formateur à la configuration et l'utilisation "text/plain" comme le 3ème argument de CreateResponse, ou à l'utilisation de nouveaux PlaintTextFormatter() comme le 3ème argument?
    • Je serais favorable à la première option, car l'API Web sera alors de localiser le formatage approprié à partir de la configuration. Si jamais vous changez le formateur vous ne devez le faire qu'en un seul endroit.
    • Pourquoi jQuery ajax interpréter la réponse d'erreur?
    • Parce que l'OP est de retour un Bad Request (400) de réponse. return Request.CreateResponse(HttpStatusCode.BadRequest, "Line1 \r\n Line2");
    • Je suis en utilisant les suggestions de formatage ci-dessus. Il compile mais lors de l'exécution j'obtiens une erreur sur le ReadFromStreamAsync méthode "le type ou Le nom d'espace de noms 'HttpContent' n'a pas pu être trouvée (vous manque une directive using ou une référence d'assembly?)" même si j'ai l'aide de Système.Net.Http et même si je peux voir toutes les méthodes et propriétés de la variable "contenu".
    InformationsquelleAutor Ben Foster
  2. 3

    Ce que vous êtes après est une coutume MediaTypeFormatter. Il semble que vous souhaitez mettre en place votre propre personnalisé pour la remplacer et existant ou que vous êtes en train de créer un nouveau personnalisée tous ensemble, en fonction de ce que l'en-tête Accept vous vous attendez. La bonne nouvelle est que vous pouvez échanger existants ou à venir avec un nouveau MediaType vous le souhaitez. Quelques lieux qui vont vous aider à commencer peut être trouvé ici:

    http://byterot.blogspot.com/2012/04/aspnet-web-api-series-part-5.html

    http://www.asp.net/web-api/overview/formats-and-model-binding/media-formatters

    Oui, j'ai fait cette petite partie que j'ai échangé quelques formateur par défaut par exemple JSON avec une plus rapide, c'est à dire ServiceStack et il fonctionne très bien.

    InformationsquelleAutor Daron Cox