RestSharp para C# (.NET): guía completa con ejemplos

¿Qué es RestSharp y para qué sirve?

\n\n

RestSharp es una popular biblioteca open-source para el lenguaje C# (.NET), diseñada para simplificar el trabajo con APIs RESTful. Proporciona una interfaz cómoda e intuitiva para realizar solicitudes HTTP (GET, POST, PUT, DELETE, PATCH y otras) y procesar respuestas de servicios web.

\n\n

RestSharp resuelve varias tareas clave:

\n

\n
• Simplificación del código: En lugar de escribir código extenso usando HttpClient, RestSharp ofrece una interfaz fluida y concisa.
\n
• Serialización/deserialización automática: La biblioteca convierte automáticamente sus objetos C# a JSON/XML y viceversa, eliminando el trabajo manual.
\n
• Manejo conveniente de errores: RestSharp proporciona clases claras para manejar estados HTTP y excepciones.
\n
• Soporte de autenticación: Soporte integrado para OAuth, Basic Auth, JWT y otros esquemas.
\n
• Trabajo con archivos: Carga y descarga sencilla de archivos.
\n

\n\n

La biblioteca se utiliza activamente en aplicaciones .NET (ASP.NET Core, aplicaciones de consola, Xamarin, Unity) para la integración con servicios externos: redes sociales, sistemas de pago, plataformas en la nube, etc.

\n\n

Instalación de RestSharp

\n\n

RestSharp se instala a través del administrador de paquetes NuGet. Elija uno de los métodos:

\n\n

A través de Package Manager Console (Visual Studio):

\n

Install-Package RestSharp

\n\n

A través de .NET CLI (línea de comandos):

\n

dotnet add package RestSharp

\n\n

A través de la interfaz de NuGet (Visual Studio/Rider):

\n

Abra Manage NuGet Packages → busque RestSharp → instale la última versión estable.

\n\n

Después de la instalación, agregue la directiva using en su código:

\n

using RestSharp;

\n\n

Inicio rápido: primera solicitud

\n\n

Hagamos una solicitud GET simple a una API pública (JSONPlaceholder) y obtengamos una lista de usuarios.

\n\n

using RestSharp;\n\nvar client = new RestClient("https://jsonplaceholder.typicode.com");\nvar request = new RestRequest("/users", Method.Get);\n\nvar response = client.Execute(request);\n\nif (response.IsSuccessful)\n{\n    Console.WriteLine(response.Content); // Muestra la cadena JSON\n}\nelse\n{\n    Console.WriteLine($"Error: {response.StatusCode} - {response.ErrorMessage}");\n}

\n\n

Este código crea un cliente, forma una solicitud GET al endpoint /users y muestra la respuesta en la consola. Tenga en cuenta: response.IsSuccessful verifica que el estado de la respuesta esté en el rango 200-299.

\n\n

Métodos y funciones principales de RestSharp

\n\n

A continuación se presentan los métodos clave de la biblioteca con descripción, parámetros y ejemplos.

\n\n

1. RestClient(string baseUrl) — Constructor del cliente

\n

Descripción: Crea una instancia del cliente HTTP con una URL base. Todas las solicitudes posteriores usarán esta URL como base.

\n

Parámetros:

\n

\n
• baseUrl (string) — dirección base de la API (por ejemplo, "https://api.example.com").
\n

\n

Ejemplo:

\n

var client = new RestClient("https://api.github.com");

\n\n

2. RestRequest(string resource, Method method) — Creación de solicitud

\n

Descripción: Forma una solicitud HTTP al recurso especificado con el método indicado (GET, POST, PUT, DELETE, etc.).

\n

Parámetros:

\n

\n
• resource (string) — ruta relativa al recurso (por ejemplo, "/users").
\n
• method (Method) — método HTTP de la enumeración Method (Get, Post, Put, Delete, Patch, Head, Options).
\n

\n

Ejemplo:

\n

var request = new RestRequ