Skip to main content

REST Client - RESTSharp

In urma cu cîteva luni aveam nevoie de un un mecanism prin intermediul căruia sa consum servicii REST din .NET.
La prima strigare acest lucru este destul de simplu de făcut (de implementat), avem nevoie un obiect de tip HttpRequest. Dar am vrut mai mult de atît, doream un API simplu prin care sa pot sa fac apeluri REST.
O soluție la îndemîna era sa încep implementarea unui astfel de API de la 0, cea ce am și făcut în prima faza, deoarece nu este foarte complicat (mi-a luat in jur de 12 ore pana sa ajuns la un API destul de bogat).
Intre timp am început sa caut pe web ce soluții free exista și am descoperit RestSharp. Este un client pentru servicii în format REST open-source destul de robust și bine gîndit.
Ce mi-a plăcut la el cel mai mult și m-a făcut sa îl folosesc este numele la clase (foarte sugestive) și ușurința cu care se poate folosii plus ca primele linii de cod pe care le-am scris pentru acest IP au funcționat din prima. Mai jos puteți sa găsit un exemplu:
RestClient restClient = new RestClient("www.car.com");
RestRequest restRequest = new RestRequest();
restRequest.Method = Method.GET;
restRequest.Resource = "Cars/Get";
restRequest.AddParameter(
new Parameter()
{
Name = "id",
Value = "123",
Type = ParameterType.GetOrPost
});
Car car = restClient.Execute<Car>(restRequest);
Prin intermediul la restRequest putem sa facem unu sau mai multe apeluri. Detalii pentru fiecare apel de serviciu în parte sunt specificate prin intermediul unei instante de tip RestRequest. Resource se refera la adresa relativa a serviciului fata de adresa de baza.
Putem sa adaugăm oricîți parametrii, iar pentru fiecare parametru în parte se poate specifica tipul acestuia. Tipurile de parametri suportați sunt:
  • Cookie
  • GetOrPost
  • UrlSegment
  • HttpHeader
  • RequestBody
Ce mi-a plăcut este ca pot sa controlez destul de ușor unde se va adaugă fiecare parametru în parte, iar în cazul în care lucrați și cu cookie, lucrurile se simplifica destul de mult.
Parametrii de tip UrlSegment sunt destul de interesanți. Îți permit sa specifici în Resource o adresa dinamica, care în funcție de parametrii sa se poată modifica. De exemplu daca lucram cu doua versiuni de servicii, ne-ar fi util sa putem specifica locația la fiecare versiune de serviciu în parte. Pentru a putea face acest lucru putem sa scriem următorul apel:
RestRequest restRequest = new RestRequest();
restRequest.Method = Method.GET;
restRequest.Resource = "{version}/Cars/Get";
request.AddParameter("version", _version, ParameterType.UrlSegment);
In request putem sa adaugăm fișiere prin metoda AddFile, totodată putem sa specificam formatul datelor JSON sau XML. In cazul în care avem un de-serializator custom putem sa îl specificam în momentul în care setam obiectul de tip RestClient.
restClient.AddHandler("*", new JsonDeserializer());
Obiectul care este returnat nu trebuie sa fie neapărat un obiect serializabil, putem sa apelam doar metoda Execute, aceasta ne va returna un obiect de tip RestResponse, care va conține toate informațiile de care avem nevoie. Proprietatea Content ne va returna conținutul returnat de către serviciu.
Apeluri se pot face și async fără nici o problema, iar fiecare clasa din API are unit teste pentru o mare parte din funcționalități.
Un lucru destul de draguț este ca suporta cîteva tipuri de autentificare in mod default. In cazul în care aveți nevoie de un mecanism mai complicat, se poate extinde foarte ușor acest lucru prin implementarea unei interfețe.
In general cam toate cazurile de care o sa avem nevoie pentru a consuma un serviciu în format REST sunt acoperite, dar putem fără probleme sa extindem acest API. Chiar am avut nevoie sa fac acest lucru, pentru un serviciu de la Yahoo destul de ciudat. Mi-a luat cam 20 de minute sa fac acest lucru cu tot cu testare. Pana acuma personal nu am descoperit nici un bug la RESTSharp.
Din punct de vedere a documentației, exista un wiki destul de okay. Ultimul release a fost făcut în mai 2011.
Ca un overall, sunt mulțumit de acest client de REST. Daca nu o sa îl folosiți, măcar merita sa va uitați peste codul sursa înainte sa începeți sa faceți ceva asemănător. Cea mai frumoasa idee mi s-a părut ideea de a putea seta tipul la fiecare parametru în parte. A.i. aceasta lista se poate refolosii și la alte requesturi fără nici o problema.

Comments

  1. Cum ziceai mai jos, nu era mai simplu sa folosesti WCF?

    ReplyDelete

Post a Comment

Popular posts from this blog

Windows Docker Containers can make WIN32 API calls, use COM and ASP.NET WebForms

After the last post , I received two interesting questions related to Docker and Windows. People were interested if we do Win32 API calls from a Docker container and if there is support for COM. WIN32 Support To test calls to WIN32 API, let’s try to populate SYSTEM_INFO class. [StructLayout(LayoutKind.Sequential)] public struct SYSTEM_INFO { public uint dwOemId; public uint dwPageSize; public uint lpMinimumApplicationAddress; public uint lpMaximumApplicationAddress; public uint dwActiveProcessorMask; public uint dwNumberOfProcessors; public uint dwProcessorType; public uint dwAllocationGranularity; public uint dwProcessorLevel; public uint dwProcessorRevision; } ... [DllImport("kernel32")] static extern void GetSystemInfo(ref SYSTEM_INFO pSI); ... SYSTEM_INFO pSI = new SYSTEM_INFO(...

How to audit an Azure Cosmos DB

In this post, we will talk about how we can audit an Azure Cosmos DB database. Before jumping into the problem let us define the business requirement: As an Administrator I want to be able to audit all changes that were done to specific collection inside my Azure Cosmos DB. The requirement is simple, but can be a little tricky to implement fully. First of all when you are using Azure Cosmos DB or any other storage solution there are 99% odds that you’ll have more than one system that writes data to it. This means that you have or not have control on the systems that are doing any create/update/delete operations. Solution 1: Diagnostic Logs Cosmos DB allows us activate diagnostics logs and stream the output a storage account for achieving to other systems like Event Hub or Log Analytics. This would allow us to have information related to who, when, what, response code and how the access operation to our Cosmos DB was done. Beside this there is a field that specifies what was th...

Cloud Myths: Cloud is Cheaper (Pill 1 of 5 / Cloud Pills)

Cloud Myths: Cloud is Cheaper (Pill 1 of 5 / Cloud Pills) The idea that moving to the cloud reduces the costs is a common misconception. The cloud infrastructure provides flexibility, scalability, and better CAPEX, but it does not guarantee lower costs without proper optimisation and management of the cloud services and infrastructure. Idle and unused resources, overprovisioning, oversize databases, and unnecessary data transfer can increase running costs. The regional pricing mode, multi-cloud complexity, and cost variety add extra complexity to the cost function. Cloud adoption without a cost governance strategy can result in unexpected expenses. Improper usage, combined with a pay-as-you-go model, can result in a nightmare for business stakeholders who cannot track and manage the monthly costs. Cloud-native services such as AI services, managed databases, and analytics platforms are powerful, provide out-of-the-shelve capabilities, and increase business agility and innovation. H...