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

How to check in AngularJS if a service was register or not

There are cases when you need to check in a service or a controller was register in AngularJS.
For example a valid use case is when you have the same implementation running on multiple application. In this case, you may want to intercept the HTTP provider and add a custom step there. This step don’t needs to run on all the application, only in the one where the service exist and register.
A solution for this case would be to have a flag in the configuration that specify this. In the core you would have an IF that would check the value of this flag.
Another solution is to check if a specific service was register in AngularJS or not. If the service was register that you would execute your own logic.
To check if a service was register or not in AngularJS container you need to call the ‘has’ method of ‘inhector’. It will return TRUE if the service was register.
if ($injector.has('httpInterceptorService')) { $httpProvider.interceptors.push('httpInterceptorService&#…

ADO.NET provider with invariant name 'System.Data.SqlClient' could not be loaded

Today blog post will be started with the following error when running DB tests on the CI machine:
threw exception: System.InvalidOperationException: The Entity Framework provider type 'System.Data.Entity.SqlServer.SqlProviderServices, EntityFramework.SqlServer' registered in the application config file for the ADO.NET provider with invariant name 'System.Data.SqlClient' could not be loaded. Make sure that the assembly-qualified name is used and that the assembly is available to the running application. See http://go.microsoft.com/fwlink/?LinkId=260882 for more information. at System.Data.Entity.Infrastructure.DependencyResolution.ProviderServicesFactory.GetInstance(String providerTypeName, String providerInvariantName) This error happened only on the Continuous Integration machine. On the devs machines, everything has fine. The classic problem – on my machine it’s working. The CI has the following configuration:

TeamCity.NET 4.51EF 6.0.2VS2013
It seems that there …

Run native .NET application in Docker (.NET Framework 4.6.2)

Scope
The main scope of this post is to see how we can run a legacy application written in .NET Framework in Docker.

Context
First of all, let’s define what is a legacy application in our context. By a legacy application we understand an application that runs .NET Framework 3.5 or higher in a production environment where we don’t have any more the people or documentation that would help us to understand what is happening behind the scene.
In this scenarios, you might want to migrate the current solution from a standard environment to Docker. There are many advantages for such a migration, like:

Continuous DeploymentTestingIsolationSecurity at container levelVersioning ControlEnvironment Standardization
Until now, we didn’t had the possibility to run a .NET application in Docker. With .NET Core, there was support for .NET Core in Docker, but migration from a full .NET framework to .NET Core can be costly and even impossible. Not only because of lack of features, but also because once you…