.NET 4.5で新しいHttpClient
を使用してHTTP HEADリクエストを作成できますか?見つけることができるメソッドはGetAsync
、DeleteAsync
、PutAsync
、およびPostAsync
。HttpWebRequest
クラスがこれを実行できることは知っていますが、最新のHttpClient
を使用したいと思います。
次のようにして、ヘッダーのみを取得することもできます。
this.GetAsync($"http://url.com", HttpCompletionOption.ResponseHeadersRead).Result;
Web APIから返されたATMのTotalCount
を取得するために、これを行う必要がありました。 GET 方法。
@Smigの答えを試してみたところ、Web APIから次の応答が返されました。
MethodNotAllowed:プラグマ:no-cache X-SourceFiles:=?UTF-8?B?dfdsf Cache-Control:no-cache Date:Wed、22 Mar 2017 20:42:57 GMT Server:Microsoft-IIS/10.0 X-AspNet -バージョン:4.0.30319 X-Powered-By:ASP.NET
これを正常に機能させるには、@ Smigの回答に基づいて作成する必要がありました。 Web APIメソッドでは、明示的にHttp HEAD
verbをActionメソッドで属性として指定することにより。
コードコメントによるインラインの説明を含む完全なコードを次に示します。機密コードを削除しました。
HttpClient client = new HttpClient();
// set the base Host address for the Api (comes from Web.Config)
client.BaseAddress = new Uri(ConfigurationManager.AppSettings.Get("ApiBase"));
client.DefaultRequestHeaders.Accept.Clear();
client.DefaultRequestHeaders.Accept.Add(
new MediaTypeWithQualityHeaderValue("application/json"));
// Construct the HEAD only needed request. Note that I am requesting
// only the 1st page and 1st record from my API's endpoint.
HttpRequestMessage request = new HttpRequestMessage(
HttpMethod.Head,
"api/atms?page=1&pagesize=1");
HttpResponseMessage response = await client.SendAsync(request);
// FindAndParsePagingInfo is a simple helper I wrote that parses the
// json in the Header and populates a PagingInfo poco that contains
// paging info like CurrentPage, TotalPages, and TotalCount, which
// is the total number of records in the ATMs table.
// The source code is pasted separately in this answer.
var pagingInfoForAtms = HeaderParser.FindAndParsePagingInfo(response.Headers);
if (response.IsSuccessStatusCode)
// This for testing only. pagingInfoForAtms.TotalCount correctly
// contained the record count
return Content($"# of ATMs {pagingInfoForAtms.TotalCount}");
// if request failed, execution will come through to this line
// and display the response status code and message. This is how
// I found out that I had to specify the HttpHead attribute.
return Content($"{response.StatusCode} : {response.Headers.ToString()}");
}
// Specify the HttpHead attribute to avoid getting the MethodNotAllowed error.
[HttpGet, HttpHead]
[Route("Atms", Name = "AtmsList")]
public IHttpActionResult Get(string sort="id", int page = 1, int pageSize = 5)
{
try
{
// get data from repository
var atms = _atmRepository.GetAll().AsQueryable().ApplySort(sort);
// ... do some code to construct pagingInfo etc.
// .......
// set paging info in header.
HttpContext.Current.Response.Headers.Add(
"X-Pagination", JsonConvert.SerializeObject(paginationHeader));
// ...
return Ok(pagedAtms));
}
catch (Exception exception)
{
//... log and return 500 error
}
}
public static class HeaderParser
{
public static PagingInfo FindAndParsePagingInfo(HttpResponseHeaders responseHeaders)
{
// find the "X-Pagination" info in header
if (responseHeaders.Contains("X-Pagination"))
{
var xPag = responseHeaders.First(ph => ph.Key == "X-Pagination").Value;
// parse the value - this is a JSON-string.
return JsonConvert.DeserializeObject<PagingInfo>(xPag.First());
}
return null;
}
public static string GetSingleHeaderValue(HttpResponseHeaders responseHeaders,
string keyName)
{
if (responseHeaders.Contains(keyName))
return responseHeaders.First(ph => ph.Key == keyName).Value.First();
return null;
}
}