Ajouter un en-tête personnalisé pour toutes les réponses dans l'API Web

Pour cela, vous pouvez utiliser un ActionFilter (System.Web.Http.Filters)

public class AddCustomHeaderFilter : ActionFilterAttribute
{
    public override void OnActionExecuted(HttpActionExecutedContext actionExecutedContext)
    {
       actionExecutedContext.Response.Headers.Add("customHeader", "custom value date time");
    }
}

Vous pouvez ensuite appliquer le filtre à tous de votre contrôleur en ajoutant ceci dans la configuration Globale.asax par exemple :

GlobalConfiguration.Configuration.Filters.Add(new AddCustomHeaderFilter());

Vous pouvez également appliquer le filtre d'attribut à l'action que vous voulez sans le mondial cofiguration ligne.

Précédentes réponses à cette question n'est pas l'adresse que faire si votre contrôleur de l'action déclenche une exception. Il existe deux méthodes de base pour obtenir que cela fonctionne:

Ajouter un filtre d'exception:

using System.Net;
using System.Net.Http;
using System.Web.Http.Filters;

public class HeaderAdderExceptionFilter : ExceptionFilterAttribute
{
    public override void OnException(HttpActionExecutedContext context)
    {
        if (context.Response == null)
            context.Response = context.Request.CreateErrorResponse(
                HttpStatusCode.InternalServerError, context.Exception);

        context.Response.Content.Headers.Add("header", "value");
    }
}

et dans votre WebApi de l'installation:

configuration.Filters.Add(new HeaderAdderExceptionFilter());

Cette approche fonctionne, parce WebApi par défaut du gestionnaire d'exception enverra le HttpResponseMessage créé dans un filtre au lieu de construire son propre.

Remplacer le gestionnaire d'exceptions par défaut:

using System.Net;
using System.Net.Http;
using System.Web.Http.ExceptionHandling;
using System.Web.Http.Results;

public class HeaderAdderExceptionHandler : ExceptionHandler
{
    public override void Handle(ExceptionHandlerContext context)
    {
        HttpResponseMessage response = context.Request.CreateErrorResponse(
            HttpStatusCode.InternalServerError, context.Exception);
        response.Headers.Add("header", "value");

        context.Result = new ResponseMessageResult(response);
    }
}

et dans votre WebApi de l'installation:

configuration.Services.Replace(typeof(IExceptionHandler), new HeaderAdderExceptionHandler());

Vous ne pouvez pas utiliser ces deux ensemble. Bon, eh bien, vous pouvez, mais le maître ne fera jamais rien parce que le filtre déjà converti à l'exception d'une réponse.

Super important de noter que comme l'écrit, ce code va envoyer tous les détails de l'exception pour le client. Vous ne voulez probablement pas à le faire dans la production, afin de vérifier tous les surcharges sur CreateErrorResponse() et de choisir celui qui convient à vos besoins.

Conformément à ma demande, ci-dessous une seule ligne de code sert l'objectif.

System.Web.HttpContext.Current.Response.Headers.Add("Key", "Value")

J'ai combiné la normale et à l'exception de chemin d'accès dans une même classe:

public class CustomHeaderAttribute : FilterAttribute, IActionFilter, IExceptionFilter
{
private static string HEADER_KEY   { get { return "X-CustomHeader"; } }
private static string HEADER_VALUE { get { return "Custom header value"; } }
public Task<HttpResponseMessage> ExecuteActionFilterAsync(HttpActionContext actionContext, CancellationToken cancellationToken, Func<Task<HttpResponseMessage>> continuation)
{
return (new CustomHeaderAction() as IActionFilter).ExecuteActionFilterAsync(actionContext, cancellationToken, continuation);
}
public Task ExecuteExceptionFilterAsync(HttpActionExecutedContext actionExecutedContext, CancellationToken cancellationToken)
{
return (new CustomHeaderException() as IExceptionFilter).ExecuteExceptionFilterAsync(actionExecutedContext, cancellationToken);
}
private class CustomHeaderAction: ActionFilterAttribute
{
public override void OnActionExecuted(HttpActionExecutedContext actionExecutedContext)
{
if (actionExecutedContext.Response != null)
{ 
actionExecutedContext.Response.Content.Headers.Add(HEADER_KEY, HEADER_VALUE);
}
}
}
private class CustomHeaderException : ExceptionFilterAttribute
{
public override void OnException(HttpActionExecutedContext context)
{
if (context.Response == null)
{
context.Response = context.Request.CreateErrorResponse(HttpStatusCode.InternalServerError, context.Exception);
}
context.Response.Content.Headers.Add(HEADER_KEY, HEADER_VALUE);
}
}
}

Rien de compliqué, mais au moins ça me donne une place pour contrôler mes en-têtes supplémentaires. Pour l'instant c'est juste du contenu statique, mais vous avez toujours la possibilité de le raccorder à une sorte de dictionnaire générateur d'usine.