Como adicionar e obter valores de cabeçalho em WebApi


99

Eu preciso criar um método POST em WebApi para que possa enviar dados do aplicativo para o método WebApi. Não consigo obter o valor do cabeçalho.

Aqui, adicionei valores de cabeçalho no aplicativo:

 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);
        }

Seguindo o método de postagem 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();
        }
    }

Qual é o método correto para obter valores de cabeçalho?

Obrigado.

Respostas:


186

No lado da API da Web, basta usar o objeto Request em vez de criar um novo HttpRequestMessage

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

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

    return null;

Resultado -

insira a descrição da imagem aqui


Você não pode usar string token = headers.GetValues("Custom").FirstOrDefault();? Edit: Apenas notei que você combinava com o estilo original do Qs.
Aidanapword

Respondendo à minha própria Q: Não. Os headers.GetValues("somethingNotFound")lances um InvalidOperationException.
Aidanapword

Devo usar beforeSendno JQuery ajax para enviar o cabeçalho?
Si8

Perfeito ... usei o beforeSende funcionou. Incrível :) +1
Si8

qual é o tipo da variável Request e posso acessá-la dentro do método do controlador? Estou usando a API da web 2. Qual namespace eu preciso importar?
lohiarahul

21

Suponha que temos um controlador de API ProductsController: ApiController

Há uma função Get que retorna algum valor e espera algum cabeçalho de entrada (por exemplo, Nome de usuário e senha)

[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);
}

Agora podemos enviar a solicitação da página usando JQuery:

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

Espero que isso ajude alguém ...


9

Outra forma de usar o método TryGetValues.

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

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

6

Para .NET Core:

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

Ou

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);
}


5

tente estas linhas de códigos que funcionam no meu caso:

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

5

Como alguém já indicou como fazer isso com .Net Core, se seu cabeçalho contém um "-" ou algum outro caractere que não permite .Net, você pode fazer algo como:

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

1

Para WEB API 2.0:

Eu tive que usar em Request.Content.Headersvez de Request.Headers

e então declarei uma extensão conforme abaixo

  /// <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();
    }

E então eu invoquei dessa forma.

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

Espero que possa ser útil


0

Você precisa obter o HttpRequestMessage do OperationContext atual. Usando OperationContext você pode fazer assim

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

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

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

0

Para .net Core no método GET, você pode fazer assim:

 StringValues value1;
 string DeviceId = string.Empty;

  if (Request.Headers.TryGetValue("param1", out value1))
      {
                DeviceId = value1.FirstOrDefault();
      }
Ao utilizar nosso site, você reconhece que leu e compreendeu nossa Política de Cookies e nossa Política de Privacidade.
Licensed under cc by-sa 3.0 with attribution required.