NET问答: 如何在 ASP.NET Core Web API 的 Response 中添加自定义的 Header ?
咨詢區
JDawg:
我正在將 Web API 2 移植到 ASP.NET Core Web API 上,以前我都直接在 Response 屬性上添加自定義的 Header,如下代碼所示:
HttpResponseMessage?response?=?new?HttpResponseMessage(HttpStatusCode.OK); response.Headers.Add("X-Total-Count",?count.ToString()); return?ResponseMessage(response);請問在 ASP.NET Core Web API 上該如何往 Header 中添加呢?
回答區
Timothy Macharia:
很簡單,你可以在 Action 中直接拿到 Response 屬性,然后向 header 中添加你的自定義鍵值即可,參考如下代碼:
public?IActionResult?SendResponse() {Response.Headers.Add("X-Total-Count",?"20");return?Ok(); }???對了,如果你想讓所有的 Response 都添加 header,可以優先考慮 中間件,只需要在 Request Pipeline 中配置一下即可,參考代碼如下:
public?void?Configure(IApplicationBuilder?app,?IWebHostEnvironment?env){app.Use(async?(context,?next)?=>{context.Response.Headers.Add("X-Developed-By",?"Your?Name");await?next.Invoke();});app.UseEndpoints(endpoints?=>{endpoints.MapControllers();});}最后你會看到如下的 response header 中信息。
Simon_Weaver:
使用 自定義特性 也是一個非常不錯的辦法,參考如下代碼:
public?class?AddHeaderAttribute?:?ResultFilterAttribute {private?readonly?string?_name;private?readonly?string?_value;public?AddHeaderAttribute(string?name,?string?value){_name?=?name;_value?=?value;}public?override?void?OnResultExecuting(ResultExecutingContext?context){context.HttpContext.Response.Headers.Add(_name,?new?string[]?{?_value?});base.OnResultExecuting(context);} }然后可以將它標注在 API 的 Action 上,如下代碼所示:
????????[HttpGet][AddHeader("X-MyHeader",?"123")]public?IEnumerable<WeatherForecast>?Get(){var?rng?=?new?Random();return?Enumerable.Range(1,?5).Select(index?=>?new?WeatherForecast{Date?=?DateTime.Now.AddDays(index),TemperatureC?=?rng.Next(-20,?55),Summary?=?Summaries[rng.Next(Summaries.Length)]}).ToArray();}最后的效果圖如下:
點評區
不管是 request 還是 response,向 header 中配置自定義信息太常見了,比如在 request 中使用經典的 basic 驗證,感覺在 ASP.NET Core Web API 中更多的是傾向于 中間件 而不是傳統的 特性方式,反正都能實現,看個人愛好吧。????????????
總結
以上是生活随笔為你收集整理的NET问答: 如何在 ASP.NET Core Web API 的 Response 中添加自定义的 Header ?的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 2021年春招Elasticsearch
- 下一篇: 又一起.NET程序挂死, 用 Windb