Como fazer uma solicitação da Web HTTP POST

1134

Canonical
Como posso fazer uma solicitação HTTP e enviar alguns dados usando o POST método?

Posso fazer uma GETsolicitação, mas não tenho idéia de como fazer uma POSTsolicitação.

Hooch
fonte

Respostas:

2166

Existem várias maneiras de executar HTTP GETe POSTsolicitações:


Método A: HttpClient (preferencial)

Disponível em: .NET Framework 4.5+, .NET Standard 1.1+, .NET Core 1.0+.

Atualmente, é a abordagem preferida e é assíncrona e de alto desempenho. Use a versão interna na maioria dos casos, mas para plataformas muito antigas existe um pacote NuGet .

using System.Net.Http;

Configuração

É recomendável instanciar um HttpClientdurante a vida útil do aplicativo e compartilhá-lo, a menos que você tenha um motivo específico para não fazê-lo.

private static readonly HttpClient client = new HttpClient();

Veja HttpClientFactorypara uma solução de injeção de dependência .


  • POST

    var values = new Dictionary<string, string>
    {
        { "thing1", "hello" },
        { "thing2", "world" }
    };
    
    var content = new FormUrlEncodedContent(values);
    
    var response = await client.PostAsync("http://www.example.com/recepticle.aspx", content);
    
    var responseString = await response.Content.ReadAsStringAsync();
    
  • GET

    var responseString = await client.GetStringAsync("http://www.example.com/recepticle.aspx");

Método B: Bibliotecas de Terceiros

RestSharp

  • POST

     var client = new RestClient("http://example.com");
     // client.Authenticator = new HttpBasicAuthenticator(username, password);
     var request = new RestRequest("resource/{id}");
     request.AddParameter("thing1", "Hello");
     request.AddParameter("thing2", "world");
     request.AddHeader("header", "value");
     request.AddFile("file", path);
     var response = client.Post(request);
     var content = response.Content; // Raw content as string
     var response2 = client.Post<Person>(request);
     var name = response2.Data.Name;
    

Flurl.Http

É uma biblioteca mais nova com uma API fluente, testando auxiliares, usa o HttpClient sob o capô e é portátil. Está disponível via NuGet .

    using Flurl.Http;

  • POST

    var responseString = await "http://www.example.com/recepticle.aspx"
        .PostUrlEncodedAsync(new { thing1 = "hello", thing2 = "world" })
        .ReceiveString();
    
  • GET

    var responseString = await "http://www.example.com/recepticle.aspx"
        .GetStringAsync();
    

Método C: HttpWebRequest (não recomendado para novos trabalhos)

Disponível em: .NET Framework 1.1+, .NET Standard 2.0+, .NET Core 1.0+. No .NET Core, é principalmente para compatibilidade - envolve HttpClient, tem menos desempenho e não obtém novos recursos.

using System.Net;
using System.Text;  // For class Encoding
using System.IO;    // For StreamReader

  • POST

    var request = (HttpWebRequest)WebRequest.Create("http://www.example.com/recepticle.aspx");
    
    var postData = "thing1=" + Uri.EscapeDataString("hello");
        postData += "&thing2=" + Uri.EscapeDataString("world");
    var data = Encoding.ASCII.GetBytes(postData);
    
    request.Method = "POST";
    request.ContentType = "application/x-www-form-urlencoded";
    request.ContentLength = data.Length;
    
    using (var stream = request.GetRequestStream())
    {
        stream.Write(data, 0, data.Length);
    }
    
    var response = (HttpWebResponse)request.GetResponse();
    
    var responseString = new StreamReader(response.GetResponseStream()).ReadToEnd();
    
  • GET

    var request = (HttpWebRequest)WebRequest.Create("http://www.example.com/recepticle.aspx");
    
    var response = (HttpWebResponse)request.GetResponse();
    
    var responseString = new StreamReader(response.GetResponseStream()).ReadToEnd();
    

Método D: WebClient (não recomendado para novos trabalhos)

Este é um invólucro HttpWebRequest. Compare comHttpClient .

Disponível em: .NET Framework 1.1+, NET Standard 2.0+,.NET Core 2.0+

using System.Net;
using System.Collections.Specialized;

  • POST

    using (var client = new WebClient())
    {
        var values = new NameValueCollection();
        values["thing1"] = "hello";
        values["thing2"] = "world";
    
        var response = client.UploadValues("http://www.example.com/recepticle.aspx", values);
    
        var responseString = Encoding.Default.GetString(response);
    }
    
  • GET

    using (var client = new WebClient())
    {
        var responseString = client.DownloadString("http://www.example.com/recepticle.aspx");
    }
Evan Mulawski
fonte
2
@Lloyd:HttpWebResponse response = (HttpWebResponse)HttpWReq.GetResponse();
Evan Mulawski
2
Por que você usa ASCII? E se alguém precisar de um xml com UTF-8?
Gero
8
Eu odeio para bater um cavalo morto, mas você deve fazerresponse.Result.Content.ReadAsStringAsync()
David S.
13
por que você disse que WebRequest e WebClient são herdados? O MSDN não diz que eles estão obsoletos ou algo assim. Estou esquecendo de algo?
Hiep
23
@ Hiep: Eles não são preteridos, existem apenas maneiras mais recentes (e, na maioria dos casos, melhores e mais flexíveis) de fazer solicitações da Web. Na minha opinião, para operações simples e não críticas, os métodos antigos são ótimos - mas depende de você e do que você se sentir mais confortável.
Evan Mulawski
385

Solicitação GET simples

using System.Net;

...

using (var wb = new WebClient())
{
    var response = wb.DownloadString(url);
}

Pedido POST simples

using System.Net;
using System.Collections.Specialized;

...

using (var wb = new WebClient())
{
    var data = new NameValueCollection();
    data["username"] = "myUser";
    data["password"] = "myPassword";

    var response = wb.UploadValues(url, "POST", data);
    string responseInString = Encoding.UTF8.GetString(response);
}
Pavlo Neiman
fonte
16
+1 Para coisas normais do POST, é ótimo ter um código tão curto.
user_v
3
Tim - Se você clicar com o botão direito do mouse no literal que não pode ser resolvido, encontrará um menu de contexto Resolver, que contém ações para adicionar as instruções Using para você. Se o menu de contexto Resolver não aparecer, significa que você precisará adicionar referências primeiro.
Cameron Wilby #
Aceitei sua resposta como boa, porque é muito mais simples e clara.
Hooch
13
Gostaria de acrescentar que a variável de resposta para a solicitação POST é uma matriz de bytes. Para obter a resposta da string, basta fazer Encoding.ASCII.GetString (response); (using System.Text)
Sindre 17/01
1
Além disso, você pode enviar uma matriz um pouco complexa $ _POST ['usuário'] como: data ["usuário [nome de usuário]"] = "meu nome de usuário"; data ["usuário [senha]"] = "minha senha";
Bimal Poudel
68

MSDN tem uma amostra.

using System;
using System.IO;
using System.Net;
using System.Text;

namespace Examples.System.Net
{
    public class WebRequestPostExample
    {
        public static void Main()
        {
            // Create a request using a URL that can receive a post. 
            WebRequest request = WebRequest.Create("http://www.contoso.com/PostAccepter.aspx");
            // Set the Method property of the request to POST.
            request.Method = "POST";
            // Create POST data and convert it to a byte array.
            string postData = "This is a test that posts this string to a Web server.";
            byte[] byteArray = Encoding.UTF8.GetBytes(postData);
            // Set the ContentType property of the WebRequest.
            request.ContentType = "application/x-www-form-urlencoded";
            // Set the ContentLength property of the WebRequest.
            request.ContentLength = byteArray.Length;
            // Get the request stream.
            Stream dataStream = request.GetRequestStream();
            // Write the data to the request stream.
            dataStream.Write(byteArray, 0, byteArray.Length);
            // Close the Stream object.
            dataStream.Close();
            // Get the response.
            WebResponse response = request.GetResponse();
            // Display the status.
            Console.WriteLine(((HttpWebResponse)response).StatusDescription);
            // Get the stream containing content returned by the server.
            dataStream = response.GetResponseStream();
            // Open the stream using a StreamReader for easy access.
            StreamReader reader = new StreamReader(dataStream);
            // Read the content.
            string responseFromServer = reader.ReadToEnd();
            // Display the content.
            Console.WriteLine(responseFromServer);
            // Clean up the streams.
            reader.Close();
            dataStream.Close();
            response.Close();
        }
    }
}
Otávio Décio
fonte
Por alguma razão não funcionou quando eu estava enviando grande quantidade de dados
AnKing
26

Este é um exemplo completo de envio / recebimento de dados no formato JSON, usei o Visual Studio 2013 Express Edition:

using System;
using System.Collections.Generic;
using System.Data;
using System.Data.OleDb;
using System.IO;
using System.Linq;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;
using System.Web.Script.Serialization;

namespace ConsoleApplication1
{
    class Customer
    {
        public string Name { get; set; }
        public string Address { get; set; }
        public string Phone { get; set; }
    }

    public class Program
    {
        private static readonly HttpClient _Client = new HttpClient();
        private static JavaScriptSerializer _Serializer = new JavaScriptSerializer();

        static void Main(string[] args)
        {
            Run().Wait();
        }

        static async Task Run()
        {
            string url = "http://www.example.com/api/Customer";
            Customer cust = new Customer() { Name = "Example Customer", Address = "Some example address", Phone = "Some phone number" };
            var json = _Serializer.Serialize(cust);
            var response = await Request(HttpMethod.Post, url, json, new Dictionary<string, string>());
            string responseText = await response.Content.ReadAsStringAsync();

            List<YourCustomClassModel> serializedResult = _Serializer.Deserialize<List<YourCustomClassModel>>(responseText);

            Console.WriteLine(responseText);
            Console.ReadLine();
        }

        /// <summary>
        /// Makes an async HTTP Request
        /// </summary>
        /// <param name="pMethod">Those methods you know: GET, POST, HEAD, etc...</param>
        /// <param name="pUrl">Very predictable...</param>
        /// <param name="pJsonContent">String data to POST on the server</param>
        /// <param name="pHeaders">If you use some kind of Authorization you should use this</param>
        /// <returns></returns>
        static async Task<HttpResponseMessage> Request(HttpMethod pMethod, string pUrl, string pJsonContent, Dictionary<string, string> pHeaders)
        {
            var httpRequestMessage = new HttpRequestMessage();
            httpRequestMessage.Method = pMethod;
            httpRequestMessage.RequestUri = new Uri(pUrl);
            foreach (var head in pHeaders)
            {
                httpRequestMessage.Headers.Add(head.Key, head.Value);
            }
            switch (pMethod.Method)
            {
                case "POST":
                    HttpContent httpContent = new StringContent(pJsonContent, Encoding.UTF8, "application/json");
                    httpRequestMessage.Content = httpContent;
                    break;

            }

            return await _Client.SendAsync(httpRequestMessage);
        }
    }
}
Ivanzinho
fonte
8

Existem algumas respostas realmente boas aqui. Deixe-me postar uma maneira diferente de definir seus cabeçalhos com o WebClient (). Também mostrarei como definir uma chave de API.

        var client = new WebClient();
        string credentials = Convert.ToBase64String(Encoding.ASCII.GetBytes(userName + ":" + passWord));
        client.Headers[HttpRequestHeader.Authorization] = $"Basic {credentials}";
        //If you have your data stored in an object serialize it into json to pass to the webclient with Newtonsoft's JsonConvert
        var encodedJson = JsonConvert.SerializeObject(newAccount);

        client.Headers.Add($"x-api-key:{ApiKey}");
        client.Headers.Add("Content-Type:application/json");
        try
        {
            var response = client.UploadString($"{apiurl}", encodedJson);
            //if you have a model to deserialize the json into Newtonsoft will help bind the data to the model, this is an extremely useful trick for GET calls when you have a lot of data, you can strongly type a model and dump it into an instance of that class.
            Response response1 = JsonConvert.DeserializeObject<Response>(response);
Adão
fonte
Útil, obrigado. BTW Parece que a técnica acima para definir propriedades de cabeçalho também funciona para a abordagem HttpWebRequest mais antiga (descontinuada?). por exemplo, myReq.Headers [HttpRequestHeader.Authorization] = $ "Básico {credenciais}";
Zeek2
6

Esta solução usa nada além de chamadas .NET padrão.

Testado:

  • Em uso em um aplicativo WPF corporativo. Usa assíncrono / espera para evitar o bloqueio da interface do usuário.
  • Compatível com .NET 4.5+.
  • Testado sem parâmetros (requer um "GET" nos bastidores).
  • Testado com parâmetros (requer um "POST" nos bastidores).
  • Testado com uma página da web padrão como o Google.
  • Testado com um serviço da web interno baseado em Java.

Referência:

// Add a Reference to the assembly System.Web

Código:

using System;
using System.Collections.Generic;
using System.Collections.Specialized;
using System.Net;
using System.Net.Http;
using System.Threading.Tasks;
using System.Web;

private async Task<WebResponse> CallUri(string url, TimeSpan timeout)
{
    var uri = new Uri(url);
    NameValueCollection rawParameters = HttpUtility.ParseQueryString(uri.Query);
    var parameters = new Dictionary<string, string>();
    foreach (string p in rawParameters.Keys)
    {
        parameters[p] = rawParameters[p];
    }

    var client = new HttpClient { Timeout = timeout };
    HttpResponseMessage response;
    if (parameters.Count == 0)
    {
        response = await client.GetAsync(url);
    }
    else
    {
        var content = new FormUrlEncodedContent(parameters);
        string urlMinusParameters = uri.OriginalString.Split('?')[0]; // Parameters always follow the '?' symbol.
        response = await client.PostAsync(urlMinusParameters, content);
    }
    var responseString = await response.Content.ReadAsStringAsync();

    return new WebResponse(response.StatusCode, responseString);
}

private class WebResponse
{
    public WebResponse(HttpStatusCode httpStatusCode, string response)
    {
        this.HttpStatusCode = httpStatusCode;
        this.Response = response;
    }
    public HttpStatusCode HttpStatusCode { get; }
    public string Response { get; }
}

Para chamar sem parâmetros (usa um "GET" nos bastidores):

 var timeout = TimeSpan.FromSeconds(300);
 WebResponse response = await this.CallUri("http://www.google.com/", timeout);
 if (response.HttpStatusCode == HttpStatusCode.OK)
 {
     Console.Write(response.Response); // Print HTML.
 }

Para chamar com parâmetros (usa um "POST" nos bastidores):

 var timeout = TimeSpan.FromSeconds(300);
 WebResponse response = await this.CallUri("http://example.com/path/to/page?name=ferret&color=purple", timeout);
 if (response.HttpStatusCode == HttpStatusCode.OK)
 {
     Console.Write(response.Response); // Print HTML.
 }
Contango
fonte
6

Solução simples (one-liner, sem verificação de erros, sem espera de resposta) que encontrei até agora:

(new WebClient()).UploadStringAsync(new Uri(Address), dataString);‏

Use com cuidado!

Ohad Cohen
fonte
5
Isso é muito ruim. Eu não recomendo, pois não há nenhum tratamento de erro de qualquer tipo e depuração é doloroso. Além disso, já existe uma ótima resposta para esta pergunta.
Hooch
1
@ Hooch outros podem estar interessados ​​neste tipo de respostas, mesmo que não seja a melhor.
Mitulát Bati
Acordado, o único contexto em que isso seria útil é golfe código e que joga golfe em C #;)
Extragorey
4

Ao usar o namespace Windows.Web.Http , para POST em vez de FormUrlEncodedContent, escrevemos HttpFormUrlEncodedContent. Além disso, a resposta é do tipo HttpResponseMessage. O resto é como Evan Mulawski escreveu.

S4NNY1
fonte
4

Se você gosta de uma API fluente, pode usar o Tiny.RestClient . Está disponível no NuGet .

var client = new TinyRestClient(new HttpClient(), "http://MyAPI.com/api");
// POST
var city = new City() { Name = "Paris", Country = "France" };
// With content
var response = await client.PostRequest("City", city)
                           .ExecuteAsync<bool>();
user8803505
fonte
1

Por que isso não é totalmente trivial? Fazer a solicitação não está, e principalmente, não está lidando com os resultados e parece que existem alguns erros do .NET envolvidos - consulte Bug no HttpClient.GetAsync deve lançar WebException, não TaskCanceledException

Acabei com este código:

static async Task<(bool Success, WebExceptionStatus WebExceptionStatus, HttpStatusCode? HttpStatusCode, string ResponseAsString)> HttpRequestAsync(HttpClient httpClient, string url, string postBuffer = null, CancellationTokenSource cts = null) {
    try {
        HttpResponseMessage resp = null;

        if (postBuffer is null) {
            resp = cts is null ? await httpClient.GetAsync(url) : await httpClient.GetAsync(url, cts.Token);

        } else {
            using (var httpContent = new StringContent(postBuffer)) {
                resp = cts is null ? await httpClient.PostAsync(url, httpContent) : await httpClient.PostAsync(url, httpContent, cts.Token);
            }
        }

        var respString = await resp.Content.ReadAsStringAsync();
        return (resp.IsSuccessStatusCode, WebExceptionStatus.Success, resp.StatusCode, respString);

    } catch (WebException ex) {
        WebExceptionStatus status = ex.Status;
        if (status == WebExceptionStatus.ProtocolError) {
            // Get HttpWebResponse so that you can check the HTTP status code.
            using (HttpWebResponse httpResponse = (HttpWebResponse)ex.Response) {
                return (false, status, httpResponse.StatusCode, httpResponse.StatusDescription);
            }
        } else {
            return (false, status, null, ex.ToString()); 
        }

    } catch (TaskCanceledException ex) {
        if (cts is object && ex.CancellationToken == cts.Token) {
            // a real cancellation, triggered by the caller
            return (false, WebExceptionStatus.RequestCanceled, null, ex.ToString());
        } else {
            // a web request timeout (possibly other things!?)
            return (false, WebExceptionStatus.Timeout, null, ex.ToString());
        }

    } catch (Exception ex) {
        return (false, WebExceptionStatus.UnknownError, null, ex.ToString());
    }
}

Isso fará com que um GET ou POST dependa se postBufferfor nulo ou não

se Sucesso for verdadeiro, a resposta estará em ResponseAsString

Se o sucesso é falso você pode verificar WebExceptionStatus, HttpStatusCodee ResponseAsStringtentar ver o que deu errado.

kofifus
fonte
0

No núcleo .net, você pode fazer uma pós-chamada com o código a seguir, aqui adicionei alguns recursos extras a esse código para que seu código funcione por trás de um proxy e com credenciais de rede, se houver, também menciono aqui que você pode alterar a codificação de sua mensagem. Espero que isso explique tudo e ajude você na codificação.

HttpClient client = GetHttpClient(_config);

        if (headers != null)
        {
            foreach (var header in headers)
            {
                client.DefaultRequestHeaders.TryAddWithoutValidation(header.Key, header.Value);
            }
        }

        client.BaseAddress = new Uri(baseAddress);

        Encoding encoding = Encoding.UTF8;


        var result = await client.PostAsync(url, new StringContent(body, encoding, "application/json")).ConfigureAwait(false);
        if (result.IsSuccessStatusCode)
        {
            return new RequestResponse { severity = "Success", httpResponse = result.Content.ReadAsStringAsync().Result, StatusCode = result.StatusCode };
        }
        else
        {
            return new RequestResponse { severity = "failure", httpResponse = result.Content.ReadAsStringAsync().Result, StatusCode = result.StatusCode };
        }


 public HttpClient GetHttpClient(IConfiguration _config)
        {
            bool ProxyEnable = Convert.ToBoolean(_config["GlobalSettings:ProxyEnable"]);

            HttpClient client = null;
            if (!ProxyEnable)
            {
                client = new HttpClient();
            }
            else
            {
                string ProxyURL = _config["GlobalSettings:ProxyURL"];
                string ProxyUserName = _config["GlobalSettings:ProxyUserName"];
                string ProxyPassword = _config["GlobalSettings:ProxyPassword"];
                string[] ExceptionURL = _config["GlobalSettings:ExceptionURL"].Split(';');
                bool BypassProxyOnLocal = Convert.ToBoolean(_config["GlobalSettings:BypassProxyOnLocal"]);
                bool UseDefaultCredentials = Convert.ToBoolean(_config["GlobalSettings:UseDefaultCredentials"]);

                WebProxy proxy = new WebProxy
                {
                    Address = new Uri(ProxyURL),
                    BypassProxyOnLocal = BypassProxyOnLocal,
                    UseDefaultCredentials = UseDefaultCredentials,
                    BypassList = ExceptionURL,
                    Credentials = new NetworkCredential(ProxyUserName, ProxyPassword)

                };

                HttpClientHandler handler = new HttpClientHandler { Proxy = proxy };
                client = new HttpClient(handler,true);
            }
            return client;
        }
Syed Fahad Ali
fonte