Aggiungere un'intestazione di risposta personalizzata in ApiController

Question

Fino ad ora, ho avuto un metodo GET che sembrava il seguente:

protected override async Task<IHttpActionResult> GetAll(QueryData query) 
{ 
    // ... Some operations 

    //LINQ Expression based on the query parameters 
    Expression<Func<Entity, bool>> queryExpression = BuildQueryExpression(query); 

    //Begin to count all the entities in the repository 
    Task<int> countingEntities = repo.CountAsync(queryExpression); 

    //Reads an entity that will be the page start 
    Entity start = await repo.ReadAsync(query.Start); 

    //Reads all the entities starting from the start entity 
    IEnumerable<Entity> found = await repo.BrowseAllAsync(start, queryExpression); 

    //Truncates to page size 
    found = found.Take(query.Size); 

    //Number of entities returned in response 
    int count = found.Count(); 

    //Number of total entities (without pagination) 
    int total = await countingEntities; 

    return Ok(new { 
      Total = total, 
      Count = count, 
      Last = count > 0 ? GetEntityKey(found.Last()) : default(Key), 
      Data = found.Select(e => IsResourceOwner(e) ? MapToOwnerDTO(e) : MapToDTO(e)).ToList() 
    }); 
} 

Il tutto ha funzionato come un fascino ed è stato bello. Tuttavia, mi è stato detto di recente di inviare la risposta metadata (ovvero, Total, Count e Last proprietà) come intestazioni personalizzate di risposta anziché il corpo della risposta.

Non riesco ad accedere a Response da ApiController. Ho pensato a un filtro o attributo, ma come avrei ottenuto i valori dei metadati?

Posso mantenere tutte queste informazioni sulla risposta e quindi disporre di un filtro che deserializza la risposta prima di essere inviata al client e creane una nuova con le intestazioni, ma ciò sembra problematico e negativo.

C'è un modo per aggiungere intestazioni personalizzate direttamente da questo metodo su un ApiController?

Answer 1

ho inserito, ecco la mia risposta completa.

Sarà necessario creare un filtro personalizzato e applicarlo al controller.

public class CustomHeaderFilter : ActionFilterAttribute 
{ 
    public override void OnActionExecuted(HttpActionExecutedContext actionExecutedContext) 
    { 
     var count = actionExecutedContext.Request.Properties["Count"]; 
     actionExecutedContext.Response.Content.Headers.Add("totalHeader", count); 
    } 
} 

nel controller

public class AddressController : ApiController 
     { 
      public async Task<Address> Get() 
      { 
       Request.Properties["Count"] = "123"; 
      } 
    } 

Answer 2

è possibile utilizzare un ActionFilter personalizzato che vi permetterà di inviare le intestazioni personalizzate e accedere al HttpContext: commenti

public class AddCustomHeaderFilter : ActionFilterAttribute 
{ 
    public override void OnActionExecuted(HttpActionExecutedContext actionExecutedContext) 
    { 
     actionExecutedContext.Response.Content.Headers.Add("name", "value"); 
    } 
} 

Answer 3

È possibile aggiungere in modo esplicito intestazioni personalizzate in un metodo in questo modo:

[HttpGet] 
[Route("home/students")] 
public HttpResponseMessage GetStudents() 
{ 
     // Get students from Database 

     // Create the response 
     var response = Request.CreateResponse(HttpStatusCode.OK, studends); 

     // Set headers for paging 
     response.Headers.Add("X-Students-Total-Count", studends.Count()); 

     return response; 
} 

Per ulteriori informazioni leggere questo articolo: http://www.jerriepelser.com/blog/paging-in-aspnet-webapi-http-headers/

Answer 4

Quello che è necessario:

public async Task<IHttpActionResult> Get() 
{ 
    var response = Request.CreateResponse(); 
    response.Headers.Add("Lorem", "ipsum"); 

    return base.ResponseMessage(response); 
} 

Spero che questo risponda alla tua domanda.