Как добавить и получить значения заголовка в WebApi


103

Мне нужно создать метод POST в WebApi, чтобы я мог отправлять данные из приложения в метод WebApi. Я не могу получить значение заголовка.

Здесь я добавил в приложение значения заголовка:

 using (var client = new WebClient())
        {
            // Set the header so it knows we are sending JSON.
            client.Headers[HttpRequestHeader.ContentType] = "application/json";

            client.Headers.Add("Custom", "sample");
            // Make the request
            var response = client.UploadString(url, jsonObj);
        }

Следуя методу публикации WebApi:

 public string Postsam([FromBody]object jsonData)
    {
        HttpRequestMessage re = new HttpRequestMessage();
        var headers = re.Headers;

        if (headers.Contains("Custom"))
        {
            string token = headers.GetValues("Custom").First();
        }
    }

Каков правильный метод получения значений заголовков?

Спасибо.

Ответы:


193

На стороне веб-API просто используйте объект Request вместо создания нового HttpRequestMessage

     var re = Request;
    var headers = re.Headers;

    if (headers.Contains("Custom"))
    {
        string token = headers.GetValues("Custom").First();
    }

    return null;

Выход -

введите описание изображения здесь


Можно не использовать string token = headers.GetValues("Custom").FirstOrDefault();? Изменить: только что заметил, что вы соответствуете оригинальному стилю Qs.
Aidanapword

Отвечая на свой вопрос: Нет. headers.GetValues("somethingNotFound")Бросает InvalidOperationException.
Aidanapword

Могу ли я использовать beforeSendв JQuery ajax для отправки заголовка?
Si8

Отлично ... Я использовал, beforeSendи это сработало. Потрясающе :) +1
Si8

каков тип переменной запроса и могу ли я получить к ней доступ внутри метода контроллера? Я использую веб-API 2. Какое пространство имен мне нужно импортировать?
lohiarahul

22

Предположим, у нас есть API-контроллер ProductsController: ApiController

Существует функция Get, которая возвращает некоторое значение и ожидает некоторый входной заголовок (например, UserName & Password).

[HttpGet]
public IHttpActionResult GetProduct(int id)
{
    System.Net.Http.Headers.HttpRequestHeaders headers = this.Request.Headers;
    string token = string.Empty;
    string pwd = string.Empty;
    if (headers.Contains("username"))
    {
        token = headers.GetValues("username").First();
    }
    if (headers.Contains("password"))
    {
        pwd = headers.GetValues("password").First();
    }
    //code to authenticate and return some thing
    if (!Authenticated(token, pwd)
        return Unauthorized();
    var product = products.FirstOrDefault((p) => p.Id == id);
    if (product == null)
    {
        return NotFound();
    }
    return Ok(product);
}

Теперь мы можем отправить запрос со страницы с помощью JQuery:

$.ajax({
    url: 'api/products/10',
    type: 'GET',
    headers: { 'username': 'test','password':'123' },
    success: function (data) {
        alert(data);
    },
    failure: function (result) {
        alert('Error: ' + result);
    }
});

Надеюсь, это кому-то поможет ...


9

Другой способ использования метода TryGetValues.

public string Postsam([FromBody]object jsonData)
{
    IEnumerable<string> headerValues;

    if (Request.Headers.TryGetValues("Custom", out headerValues))
    {
        string token = headerValues.First();
    }
}   

6

Для .NET Core:

string Token = Request.Headers["Custom"];

Или

var re = Request;
var headers = re.Headers;
string token = string.Empty;
StringValues x = default(StringValues);
if (headers.ContainsKey("Custom"))
{
   var m = headers.TryGetValue("Custom", out x);
}

6

Если кто-то использует ASP.NET Core для привязки модели,

https://docs.microsoft.com/en-us/aspnet/core/mvc/models/model-binding

Встроена поддержка извлечения значений из заголовка с помощью атрибута [FromHeader].

public string Test([FromHeader]string Host, [FromHeader]string Content-Type )
{
     return $"Host: {Host} Content-Type: {Content-Type}";
}

3
Content-Typeне является допустимым идентификатором C #
thepirat000

6

Как кто-то уже указывал, как это сделать с .Net Core, если ваш заголовок содержит «-» или какой-либо другой символ, запрещенный .Net, вы можете сделать что-то вроде:

public string Test([FromHeader]string host, [FromHeader(Name = "Content-Type")] string contentType)
{
}

5

попробуйте эту строку кодов, работающих в моем случае:

IEnumerable<string> values = new List<string>();
this.Request.Headers.TryGetValues("Authorization", out values);

3

Для WEB API 2.0:

Мне пришлось использовать Request.Content.Headersвместо Request.Headers

а затем я объявил extestion, как показано ниже

  /// <summary>
    /// Returns an individual HTTP Header value
    /// </summary>
    /// <param name="headers"></param>
    /// <param name="key"></param>
    /// <returns></returns>
    public static string GetHeader(this HttpContentHeaders headers, string key, string defaultValue)
    {
        IEnumerable<string> keys = null;
        if (!headers.TryGetValues(key, out keys))
            return defaultValue;

        return keys.First();
    }

И затем я вызвал его таким образом.

  var headerValue = Request.Content.Headers.GetHeader("custom-header-key", "default-value");

Я надеюсь это может быть полезно


0

Вам нужно получить HttpRequestMessage из текущего OperationContext. Используя OperationContext, вы можете сделать это так

OperationContext context = OperationContext.Current;
MessageProperties messageProperties = context.IncomingMessageProperties;

HttpRequestMessageProperty requestProperty = messageProperties[HttpRequestMessageProperty.Name] as HttpRequestMessageProperty;

string customHeaderValue = requestProperty.Headers["Custom"];

0

Для .net Core в методе GET вы можете сделать следующее:

 StringValues value1;
 string DeviceId = string.Empty;

  if (Request.Headers.TryGetValue("param1", out value1))
      {
                DeviceId = value1.FirstOrDefault();
      }
Используя наш сайт, вы подтверждаете, что прочитали и поняли нашу Политику в отношении файлов cookie и Политику конфиденциальности.
Licensed under cc by-sa 3.0 with attribution required.