Inhalt fehlt für 404 Antworten

Question

Ich versuche benutzerdefinierte Fehlerantworten von web.api zurückzugeben. Lass es einfach String "Oops!" als JSON formatiert sein. Also habe ich einfach delegierenden Handler, die Fehlerreaktionen wie folgt ersetzt:

public class ErrorMessageHandler : DelegatingHandler 
{ 
    protected override async Task<HttpResponseMessage> SendAsync(
     HttpRequestMessage request, CancellationToken cancellationToken) 
    { 
     var response = await base.SendAsync(request, cancellationToken); 

     if (response.IsSuccessStatusCode) 
      return response; 

     var formatter = new JsonMediaTypeFormatter(); 
     var errorResponse = request.CreateResponse(response.StatusCode, "Oops!", formatter); 
     return errorResponse; 
    } 
} 

Weiter stelle ich sicher, dass dies die einzige Message-Handler in der Pipeline:

httpConfig.MessageHandlers.Clear(); 
httpConfig.MessageHandlers.Add(new ErrorMessageHandler()); 

// Only default route 
httpConfig.Routes.MapHttpRoute(
     name: "DefaultApi", 
     routeTemplate: "api/{controller}/{id}", 
     defaults: new { id = RouteParameter.Optional } 
    ); 

app.UseWebApi(httpConfig); // OWIN self-hosting 

Controller ist auch einfachste:

public class ValuesController : ApiController 
{ 
    public IHttpActionResult Get(int id) 
    { 
     if (id == 42) 
     return Ok("Answer to the Ultimate Question of Life, the Universe, and Everything"); 

     return NotFound(); 
    } 
} 

Und hier geht interessant:

• /api/values/42 gibt mir 200 Antwort mit String-Wert
• /api/values/13 gibt mir 404-Antwort mit meinem benutzerdefinierten "Oops!" String
• /api/values/42/missing mir leer 404 Antwort

Der letzte Fall gibt, ist mein Problem. Wenn ich einen Haltepunkt in der letzten Zeile des delegierenden Handlers einstelle, sehe ich klar, dass errorResponseObjectContent<string> mit dem korrekten Wert enthält. Aber warum wird dieser Wert später weggeräumt?

Answer 1

Der Grund ist dieser Code in HttpMessageHandlerAdapter.InvokeCore (also im Grunde in UseWebApi Middleware):

response = await _messageInvoker.SendAsync(request, cancellationToken); 
// ... 
if (IsSoftNotFound(request, response)) { 
     callNext = true; 
} 
else { 
    // ... 
} 

Wo IsSoftNotFound ist:

private static bool IsSoftNotFound(HttpRequestMessage request, HttpResponseMessage response) 
{ 
    if (response.StatusCode == HttpStatusCode.NotFound) 
    { 
     bool routingFailure; 
     if (request.Properties.TryGetValue<bool>(HttpPropertyKeys.NoRouteMatched, out routingFailure) 
      && routingFailure) 
     { 
      return true; 
     } 
    } 
    return false; 
} 

Also im Grunde bei "weichen" 404, wo „soft "bedeutet, dass keine Route übereinstimmt (und durch die Eigenschaft mit einem bestimmten Schlüssel in request.Properties angezeigt wird) - Middleware ruft eine nächste Komponente auf. Sonst - wird nur Antwort senden.

Diese IsSoftDelete gilt für Ihren Fall (weil in der Tat keine Route übereinstimmt) und die nächste Komponente (hatte keine Zeit, um herauszufinden, was das wirklich ist) löscht Ihre Antwort Inhalt.

zu „reparieren“ dieses Problem - entfernen Eigenschaft mit diesem Schlüssel von der Anfrage nach Aufforderung durch vorherige Handler behandelt wurde:

public class ErrorMessageHandler : DelegatingHandler { 
    protected override async Task<HttpResponseMessage> SendAsync(
     HttpRequestMessage request, CancellationToken cancellationToken) { 
     var response = await base.SendAsync(request, cancellationToken); 

     if (response.IsSuccessStatusCode) 
      return response; 

     // here, can also check if 404 
     request.Properties.Remove(HttpPropertyKeys.NoRouteMatched); 
     var formatter = new JsonMediaTypeFormatter(); 
     var errorResponse = request.CreateResponse(response.StatusCode, "Oops!", formatter); 
     return errorResponse; 
    } 
}