HttpClient Clase

Definición

Espacio de nombres:

System.Net.Http

Ensamblado:

System.Net.Http.dll

Source:

HttpClient.cs

Proporciona una clase para enviar solicitudes HTTP y recibir respuestas HTTP de un recurso identificado por un URI.

C#

public class HttpClient : System.Net.Http.HttpMessageInvoker

Herencia

Object

HttpMessageInvoker

HttpClient

Ejemplos

C#

// HttpClient is intended to be instantiated once per application, rather than per-use. See Remarks.
static readonly HttpClient client = new HttpClient();

static async Task Main()
{
    // Call asynchronous network methods in a try/catch block to handle exceptions.
    try
    {
        using HttpResponseMessage response = await client.GetAsync("http://www.contoso.com/");
        response.EnsureSuccessStatusCode();
        string responseBody = await response.Content.ReadAsStringAsync();
        // Above three lines can be replaced with new helper method below
        // string responseBody = await client.GetStringAsync(uri);

        Console.WriteLine(responseBody);
    }
    catch (HttpRequestException e)
    {
        Console.WriteLine("\nException Caught!");
        Console.WriteLine("Message :{0} ", e.Message);
    }
}

Comentarios

Para obtener más información sobre esta API, consulte Comentarios complementarios de la API para HttpClient.

Constructores

HttpClient()	Inicializa una nueva instancia de la clase HttpClient mediante un controlador HttpClientHandler que se elimina cuando se elimina esta instancia.
HttpClient(HttpMessageHandler)	Inicializa una nueva instancia de la clase HttpClient con el controlador especificado. El controlador se elimina cuando se elimina esta instancia.
HttpClient(HttpMessageHandler, Boolean)	Inicializa una nueva instancia de la clase HttpClient con el controlador proporcionado y especifica si se debe eliminar ese controlador cuando se elimine esta instancia.

Propiedades

BaseAddress	Obtiene o establece la dirección base de Identificador uniforme de recursos (URI) del recurso de Internet utilizado cuando se envían solicitudes.
DefaultProxy	Obtiene o establece el proxy HTTP global.
DefaultRequestHeaders	Obtiene los encabezados que se deben enviar con cada solicitud.
DefaultRequestVersion	Obtiene o establece la versión HTTP predeterminada utilizada en las solicitudes posteriores realizadas por esta instancia de HttpClient.
DefaultVersionPolicy	Obtiene o establece la directiva de versión predeterminada para solicitudes creadas implícitamente en métodos de conveniencia, por ejemplo, GetAsync(String) y PostAsync(String, HttpContent).
MaxResponseContentBufferSize	Obtiene o establece el número máximo de bytes que se van a almacenar en búfer al leer el contenido de la respuesta.
Timeout	Obtiene o establece el tiempo de espera hasta que se agota el tiempo de espera de la solicitud.

Métodos

CancelPendingRequests()	Cancela todas las solicitudes pendientes en esta instancia.
DeleteAsync(String)	Envía una solicitud DELETE al URI especificado como una operación asincrónica.
DeleteAsync(String, CancellationToken)	Envía una solicitud DELETE al URI especificado con un token de cancelación como operación asincrónica.
DeleteAsync(Uri)	Envía una solicitud DELETE al URI especificado como una operación asincrónica.
DeleteAsync(Uri, CancellationToken)	Envía una solicitud DELETE al URI especificado con un token de cancelación como operación asincrónica.
Dispose()	Libera los recursos no administrados y desecha los recursos administrados que usa HttpMessageInvoker. (Heredado de HttpMessageInvoker)
Dispose(Boolean)	Libera los recursos no administrados que usa el objeto HttpClient y, de forma opcional, desecha los recursos administrados.
Equals(Object)	Determina si el objeto especificado es igual que el objeto actual. (Heredado de Object)
GetAsync(String)	Envía una solicitud GET al URI especificado como una operación asincrónica.
GetAsync(String, CancellationToken)	Envía una solicitud GET al URI especificado con un token de cancelación como operación asincrónica.
GetAsync(String, HttpCompletionOption)	Envía una solicitud GET al URI especificado con una opción de finalización de HTTP como operación asincrónica.
GetAsync(String, HttpCompletionOption, CancellationToken)	Envía una solicitud GET al URI especificado con una opción de finalización de HTTP y un token de cancelación como operación asincrónica.
GetAsync(Uri)	Envía una solicitud GET al URI especificado como una operación asincrónica.
GetAsync(Uri, CancellationToken)	Envía una solicitud GET al URI especificado con un token de cancelación como operación asincrónica.
GetAsync(Uri, HttpCompletionOption)	Envía una solicitud GET al URI especificado con una opción de finalización de HTTP como operación asincrónica.
GetAsync(Uri, HttpCompletionOption, CancellationToken)	Envía una solicitud GET al URI especificado con una opción de finalización de HTTP y un token de cancelación como operación asincrónica.
GetByteArrayAsync(String)	Envía una solicitud GET al URI especificado y devuelve el cuerpo de la respuesta como una matriz de bytes en una operación asincrónica.
GetByteArrayAsync(String, CancellationToken)	Envía una solicitud GET al URI especificado y devuelve el cuerpo de la respuesta como una matriz de bytes en una operación asincrónica.
GetByteArrayAsync(Uri)	Envía una solicitud GET al URI especificado y devuelve el cuerpo de la respuesta como una matriz de bytes en una operación asincrónica.
GetByteArrayAsync(Uri, CancellationToken)	Envía una solicitud GET al URI especificado y devuelve el cuerpo de la respuesta como una matriz de bytes en una operación asincrónica.
GetHashCode()	Sirve como la función hash predeterminada. (Heredado de Object)
GetStreamAsync(String)	Envía una solicitud GET al URI especificado y devuelve el cuerpo de la respuesta como una secuencia en una operación asincrónica.
GetStreamAsync(String, CancellationToken)	Envía una solicitud GET al URI especificado y devuelve el cuerpo de la respuesta como una secuencia en una operación asincrónica.
GetStreamAsync(Uri)	Envía una solicitud GET al URI especificado y devuelve el cuerpo de la respuesta como una secuencia en una operación asincrónica.
GetStreamAsync(Uri, CancellationToken)	Envía una solicitud GET al URI especificado y devuelve el cuerpo de la respuesta como una secuencia en una operación asincrónica.
GetStringAsync(String)	Envía una solicitud GET al URI especificado y devuelve el cuerpo de la respuesta como una cadena en una operación asincrónica.
GetStringAsync(String, CancellationToken)	Envía una solicitud GET al URI especificado y devuelve el cuerpo de la respuesta como una cadena en una operación asincrónica.
GetStringAsync(Uri)	Envía una solicitud GET al URI especificado y devuelve el cuerpo de la respuesta como una cadena en una operación asincrónica.
GetStringAsync(Uri, CancellationToken)	Envía una solicitud GET al URI especificado y devuelve el cuerpo de la respuesta como una cadena en una operación asincrónica.
GetType()	Obtiene el Type de la instancia actual. (Heredado de Object)
MemberwiseClone()	Crea una copia superficial del Object actual. (Heredado de Object)
PatchAsync(String, HttpContent)	Envía una solicitud PATCH a un URI designado como una cadena como una operación asincrónica.
PatchAsync(String, HttpContent, CancellationToken)	Envía una solicitud PATCH con un token de cancelación a un URI representado como una cadena como una operación asincrónica.
PatchAsync(Uri, HttpContent)	Envía una solicitud PATCH como una operación asincrónica.
PatchAsync(Uri, HttpContent, CancellationToken)	Envía una solicitud PATCH con un token de cancelación como una operación asincrónica.
PostAsync(String, HttpContent)	Envía una solicitud POST al URI especificado como una operación asincrónica.
PostAsync(String, HttpContent, CancellationToken)	Envía una solicitud POST con un token de cancelación como una operación asincrónica.
PostAsync(Uri, HttpContent)	Envía una solicitud POST al URI especificado como una operación asincrónica.
PostAsync(Uri, HttpContent, CancellationToken)	Envía una solicitud POST con un token de cancelación como una operación asincrónica.
PutAsync(String, HttpContent)	Envía una solicitud PUT al URI especificado como una operación asincrónica.
PutAsync(String, HttpContent, CancellationToken)	Envía una solicitud PUT con un token de cancelación como una operación asincrónica.
PutAsync(Uri, HttpContent)	Envía una solicitud PUT al URI especificado como una operación asincrónica.
PutAsync(Uri, HttpContent, CancellationToken)	Envía una solicitud PUT con un token de cancelación como una operación asincrónica.
Send(HttpRequestMessage)	Envía una solicitud HTTP con la solicitud especificada.
Send(HttpRequestMessage, CancellationToken)	Envía una solicitud HTTP con el token de cancelación y la solicitud especificados.
Send(HttpRequestMessage, HttpCompletionOption)	Envía una solicitud HTTP.
Send(HttpRequestMessage, HttpCompletionOption, CancellationToken)	Envía una solicitud HTTP con la solicitud especificada, la opción de finalización y el token de cancelación.
SendAsync(HttpRequestMessage)	Envía una solicitud HTTP como una operación asincrónica.
SendAsync(HttpRequestMessage, CancellationToken)	Envía una solicitud HTTP como una operación asincrónica.
SendAsync(HttpRequestMessage, HttpCompletionOption)	Envía una solicitud HTTP como una operación asincrónica.
SendAsync(HttpRequestMessage, HttpCompletionOption, CancellationToken)	Envía una solicitud HTTP como una operación asincrónica.
ToString()	Devuelve una cadena que representa el objeto actual. (Heredado de Object)

Métodos de extensión

DeleteFromJsonAsync(HttpClient, String, Type, JsonSerializerOptions, CancellationToken)	Envía una solicitud DELETE al URI especificado y devuelve el valor resultante de deserializar el cuerpo de la respuesta como JSON en una operación asincrónica.
DeleteFromJsonAsync(HttpClient, String, Type, JsonSerializerContext, CancellationToken)	Envía una solicitud DELETE al URI especificado y devuelve el valor resultante de deserializar el cuerpo de la respuesta como JSON en una operación asincrónica.
DeleteFromJsonAsync(HttpClient, String, Type, CancellationToken)	Envía una solicitud DELETE al URI especificado y devuelve el valor resultante de deserializar el cuerpo de la respuesta como JSON en una operación asincrónica.
DeleteFromJsonAsync(HttpClient, Uri, Type, JsonSerializerOptions, CancellationToken)	Envía una solicitud DELETE al URI especificado y devuelve el valor resultante de deserializar el cuerpo de la respuesta como JSON en una operación asincrónica.
DeleteFromJsonAsync(HttpClient, Uri, Type, JsonSerializerContext, CancellationToken)	Envía una solicitud DELETE al URI especificado y devuelve el valor resultante de deserializar el cuerpo de la respuesta como JSON en una operación asincrónica.
DeleteFromJsonAsync(HttpClient, Uri, Type, CancellationToken)	Envía una solicitud DELETE al URI especificado y devuelve el valor resultante de deserializar el cuerpo de la respuesta como JSON en una operación asincrónica.
DeleteFromJsonAsync<TValue>(HttpClient, String, JsonSerializerOptions, CancellationToken)	Envía una solicitud DELETE al URI especificado y devuelve el valor resultante de deserializar el cuerpo de la respuesta como JSON en una operación asincrónica.
DeleteFromJsonAsync<TValue>(HttpClient, String, JsonTypeInfo<TValue>, CancellationToken)	Envía una solicitud DELETE al URI especificado y devuelve el valor resultante de deserializar el cuerpo de la respuesta como JSON en una operación asincrónica.
DeleteFromJsonAsync<TValue>(HttpClient, String, CancellationToken)	Envía una solicitud DELETE al URI especificado y devuelve el valor resultante de deserializar el cuerpo de la respuesta como JSON en una operación asincrónica.
DeleteFromJsonAsync<TValue>(HttpClient, Uri, JsonSerializerOptions, CancellationToken)	Envía una solicitud DELETE al URI especificado y devuelve el valor resultante de deserializar el cuerpo de la respuesta como JSON en una operación asincrónica.
DeleteFromJsonAsync<TValue>(HttpClient, Uri, JsonTypeInfo<TValue>, CancellationToken)	Envía una solicitud DELETE al URI especificado y devuelve el valor resultante de deserializar el cuerpo de la respuesta como JSON en una operación asincrónica.
DeleteFromJsonAsync<TValue>(HttpClient, Uri, CancellationToken)	Envía una solicitud DELETE al URI especificado y devuelve el valor resultante de deserializar el cuerpo de la respuesta como JSON en una operación asincrónica.
GetFromJsonAsAsyncEnumerable<TValue>(HttpClient, String, JsonSerializerOptions, CancellationToken)	Envía una HTTP GET solicitud al especificado requestUri y devuelve el valor resultante de deserializar el cuerpo de la respuesta como JSON en una operación enumerable asincrónica.
GetFromJsonAsAsyncEnumerable<TValue>(HttpClient, String, JsonTypeInfo<TValue>, CancellationToken)	Envía una HTTP GETsolicitud al especificado requestUri y devuelve el valor resultante de deserializar el cuerpo de la respuesta como JSON en una operación enumerable asincrónica.
GetFromJsonAsAsyncEnumerable<TValue>(HttpClient, String, CancellationToken)	Envía una HTTP GETsolicitud al especificado requestUri y devuelve el valor resultante de deserializar el cuerpo de la respuesta como JSON en una operación enumerable asincrónica.
GetFromJsonAsAsyncEnumerable<TValue>(HttpClient, Uri, JsonSerializerOptions, CancellationToken)	Envía una HTTP GETsolicitud al especificado requestUri y devuelve el valor resultante de deserializar el cuerpo de la respuesta como JSON en una operación enumerable asincrónica.
GetFromJsonAsAsyncEnumerable<TValue>(HttpClient, Uri, JsonTypeInfo<TValue>, CancellationToken)	Envía una HTTP GETsolicitud al especificado requestUri y devuelve el valor resultante de deserializar el cuerpo de la respuesta como JSON en una operación enumerable asincrónica.
GetFromJsonAsAsyncEnumerable<TValue>(HttpClient, Uri, CancellationToken)	Envía una HTTP GETsolicitud al especificado requestUri y devuelve el valor resultante de deserializar el cuerpo de la respuesta como JSON en una operación enumerable asincrónica.
GetFromJsonAsync(HttpClient, String, Type, JsonSerializerOptions, CancellationToken)	Envía una solicitud GET al URI especificado y devuelve el valor resultante de la deserialización del cuerpo de la respuesta como JSON en una operación asincrónica.
GetFromJsonAsync(HttpClient, String, Type, JsonSerializerContext, CancellationToken)	Envía una solicitud GET al URI especificado y devuelve el valor resultante de la deserialización del cuerpo de la respuesta como JSON en una operación asincrónica.
GetFromJsonAsync(HttpClient, String, Type, CancellationToken)	Envía una solicitud GET al URI especificado y devuelve el valor resultante de la deserialización del cuerpo de la respuesta como JSON en una operación asincrónica.
GetFromJsonAsync(HttpClient, Uri, Type, JsonSerializerOptions, CancellationToken)	Envía una solicitud GET al URI especificado y devuelve el valor resultante de la deserialización del cuerpo de la respuesta como JSON en una operación asincrónica.
GetFromJsonAsync(HttpClient, Uri, Type, JsonSerializerContext, CancellationToken)	Envía una solicitud GET al URI especificado y devuelve el valor resultante de la deserialización del cuerpo de la respuesta como JSON en una operación asincrónica.
GetFromJsonAsync(HttpClient, Uri, Type, CancellationToken)	Envía una solicitud GET al URI especificado y devuelve el valor resultante de la deserialización del cuerpo de la respuesta como JSON en una operación asincrónica.
GetFromJsonAsync<TValue>(HttpClient, String, JsonSerializerOptions, CancellationToken)	Envía una solicitud GET al URI especificado y devuelve el valor resultante de la deserialización del cuerpo de la respuesta como JSON en una operación asincrónica.
GetFromJsonAsync<TValue>(HttpClient, String, JsonTypeInfo<TValue>, CancellationToken)	Envía una solicitud GET al URI especificado y devuelve el valor resultante de la deserialización del cuerpo de la respuesta como JSON en una operación asincrónica.
GetFromJsonAsync<TValue>(HttpClient, String, CancellationToken)	Envía una solicitud GET al URI especificado y devuelve el valor resultante de la deserialización del cuerpo de la respuesta como JSON en una operación asincrónica.
GetFromJsonAsync<TValue>(HttpClient, Uri, JsonSerializerOptions, CancellationToken)	Envía una solicitud GET al URI especificado y devuelve el valor resultante de la deserialización del cuerpo de la respuesta como JSON en una operación asincrónica.
GetFromJsonAsync<TValue>(HttpClient, Uri, JsonTypeInfo<TValue>, CancellationToken)	Envía una solicitud GET al URI especificado y devuelve el valor resultante de la deserialización del cuerpo de la respuesta como JSON en una operación asincrónica.
GetFromJsonAsync<TValue>(HttpClient, Uri, CancellationToken)	Envía una solicitud GET al URI especificado y devuelve el valor resultante de la deserialización del cuerpo de la respuesta como JSON en una operación asincrónica.
PatchAsJsonAsync<TValue>(HttpClient, String, TValue, JsonSerializerOptions, CancellationToken)	Envía una solicitud PATCH al URI especificado que contiene el value serializado como JSON en el cuerpo de la solicitud.
PatchAsJsonAsync<TValue>(HttpClient, String, TValue, JsonTypeInfo<TValue>, CancellationToken)	Envía una solicitud PATCH al URI especificado que contiene el value serializado como JSON en el cuerpo de la solicitud.
PatchAsJsonAsync<TValue>(HttpClient, String, TValue, CancellationToken)	Envía una solicitud PATCH al URI especificado que contiene el value serializado como JSON en el cuerpo de la solicitud.
PatchAsJsonAsync<TValue>(HttpClient, Uri, TValue, JsonSerializerOptions, CancellationToken)	Envía una solicitud PATCH al URI especificado que contiene el value serializado como JSON en el cuerpo de la solicitud.
PatchAsJsonAsync<TValue>(HttpClient, Uri, TValue, JsonTypeInfo<TValue>, CancellationToken)	Envía una solicitud PATCH al URI especificado que contiene el value serializado como JSON en el cuerpo de la solicitud.
PatchAsJsonAsync<TValue>(HttpClient, Uri, TValue, CancellationToken)	Envía una solicitud PATCH al URI especificado que contiene el value serializado como JSON en el cuerpo de la solicitud.
PostAsJsonAsync<TValue>(HttpClient, String, TValue, JsonSerializerOptions, CancellationToken)	Envía una solicitud POST al URI especificado que contiene el value serializado como JSON en el cuerpo de la solicitud.
PostAsJsonAsync<TValue>(HttpClient, String, TValue, JsonTypeInfo<TValue>, CancellationToken)	Envía una solicitud POST al URI especificado que contiene el value serializado como JSON en el cuerpo de la solicitud.
PostAsJsonAsync<TValue>(HttpClient, String, TValue, CancellationToken)	Envía una solicitud POST al URI especificado que contiene el value serializado como JSON en el cuerpo de la solicitud.
PostAsJsonAsync<TValue>(HttpClient, Uri, TValue, JsonSerializerOptions, CancellationToken)	Envía una solicitud POST al URI especificado que contiene el value serializado como JSON en el cuerpo de la solicitud.
PostAsJsonAsync<TValue>(HttpClient, Uri, TValue, JsonTypeInfo<TValue>, CancellationToken)	Envía una solicitud POST al URI especificado que contiene el value serializado como JSON en el cuerpo de la solicitud.
PostAsJsonAsync<TValue>(HttpClient, Uri, TValue, CancellationToken)	Envía una solicitud POST al URI especificado que contiene el value serializado como JSON en el cuerpo de la solicitud.
PutAsJsonAsync<TValue>(HttpClient, String, TValue, JsonSerializerOptions, CancellationToken)	Envía una solicitud PUT al URI especificado que contiene el value serializado como JSON en el cuerpo de la solicitud.
PutAsJsonAsync<TValue>(HttpClient, String, TValue, JsonTypeInfo<TValue>, CancellationToken)	Envía una solicitud PUT al URI especificado que contiene el value serializado como JSON en el cuerpo de la solicitud.
PutAsJsonAsync<TValue>(HttpClient, String, TValue, CancellationToken)	Envía una solicitud PUT al URI especificado que contiene el value serializado como JSON en el cuerpo de la solicitud.
PutAsJsonAsync<TValue>(HttpClient, Uri, TValue, JsonSerializerOptions, CancellationToken)	Envía una solicitud PUT al URI especificado que contiene el value serializado como JSON en el cuerpo de la solicitud.
PutAsJsonAsync<TValue>(HttpClient, Uri, TValue, JsonTypeInfo<TValue>, CancellationToken)	Envía una solicitud PUT al URI especificado que contiene el value serializado como JSON en el cuerpo de la solicitud.
PutAsJsonAsync<TValue>(HttpClient, Uri, TValue, CancellationToken)	Envía una solicitud PUT al URI especificado que contiene el value serializado como JSON en el cuerpo de la solicitud.

Se aplica a

Consulte también

• Directrices para usar HttpClient
• Ejemplo de HttpClient