Як додати та отримати значення заголовка в WebApi


99

Мені потрібно створити метод 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();
        }
    }

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

Дякую.

Відповіді:


186

На стороні веб-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

Відповідаючи на мій власний Q: Немає headers.GetValues("somethingNotFound")Видає InvalidOperationException.
Aidanapword

Чи використовувати я beforeSendв JQuery ajax для надсилання заголовка?
Si8

Ідеально ... Я використав beforeSendі це спрацювало. Чудово :) +1
Si8

що це за тип змінної Request і чи можу я отримати доступ до неї всередині методу контролера? Я використовую web api 2. Який простір імен мені потрібно імпортувати?
lohiarahul

21

Припустимо, у нас є API Controller ProductsController: ApiController

Існує функція Get, яка повертає деяке значення та очікує певного заголовка вводу (наприклад, Ім'я користувача та Пароль)

[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

5

спробуйте ці рядки кодів, що працюють у моєму випадку:

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

5

Як хтось уже вказував, як це зробити за допомогою .Net Core, якщо ваш заголовок містить "-" або якийсь інший символ .Net забороняє, ви можете зробити щось на зразок:

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

1

Для WEB API 2.0:

Мені довелося використовувати Request.Content.Headersзамість Request.Headers

а потім я оголосив виступ, як показано нижче

  /// <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.