Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork44
.NET REST Client Framework for all platforms
License
MelbourneDeveloper/RestClient.Net
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
RestClient.Net is a powerful .NET REST API client that features task-based async, strong types, and dependency injection support for all platforms. Use it to consume ASP.NET Core Web APIs or interact with RESTful APIs over the internet in C#, F#, or Visual Basic. It's designed with functional-style programming and F# in mind.
NuGet:RestClient.Net
This release updates all dependencies and targets major versions of .NET: 4.5, 5, 6, and 7.
- First-class URLs: UtilizesUrls to treat URLs as immutablerecords with a fluent API for construction.
- Dependency Injection Support: Easily mock REST calls and add RestClient.Net to your IoC container with a single line of code.
- Async-Friendly: All operations use async and await keywords.
- Automatic Serialization: Automatically serializes request/response bodies to/from strong types (JSON, Binary, SOAP,Google Protocol Buffers). The library is decoupled from Newtonsoft, allowing you to use any serialization method or version of Newtonsoft. This means compatibility with any version of Azure Functions.
- Cross-Platform Compatibility: Install from NuGet on any platform from .NET Framework 4.5 up to .NET 5. Supports Xamarin (Mono, iOS, Android), UWP,WebAssembly, and Unity with .NET Standard 2.0.
- HTTP Methods: Supports GET, POST, PUT, PATCH, DELETE, and custom methods.
- Fluent API: Provides a fluent API for construction, non-destructive mutation, and URL construction.
- Logging: Uses .NET Core Logging -
ILogger
for logging all aspects of HTTP calls. - Thread Safety: Immutable client for thread safety.
- High-Quality Code: Tight code and complete test coverage allow you to make changes if needed.
For a complete set of examples, see theseunit tests.
usingvarclient=//Build the Url from the host namenewClient("jsonplaceholder.typicode.com".ToHttpsUriFromHost());UserPostuserPost=awaitclient.PostAsync<UserPost,UserPost>(//POST the UserPost to the servernewUserPost{title="Title"},"posts");
Dependency Injection (RestClient.Net.DependencyInjection NuGet Package)
varserviceCollection=newServiceCollection()//Add a service which has an IClient dependency.AddSingleton<IGetString,GetString1>()//Add RestClient.Net with a default Base Url of http://www.test.com.AddRestClient((o)=>o.BaseUrl="http://www.test.com".ToAbsoluteUrl());//Use HttpClient dependency injection_=serviceCollection.AddHttpClient();
publicclassGetString1:IGetString{publicIClientClient{get;}publicGetString1(IClientclient)=>Client=client;publicasyncTask<string>GetStringAsync()=>awaitClient.GetAsync<string>();}
publicclassGetString2:IGetString{publicIClientClient{get;}publicGetString2(CreateClientcreateClient){//Use the options to set the BaseUrl or other properties on the ClientClient=createClient("test",(o)=>{o.BaseUrl=o.BaseUrlwith{Host="www.test.com"};});}publicasyncTask<string>GetStringAsync()=>awaitClient.GetAsync<string>();}
//This constructs an AbsoluteUrl from the string, makes the GET call, and deserializes the JSON to a strongly typed list//The response also contains a Client with the base of the Url that you can reuse//Note: not available on .NET 4.5varresponse=await"https://restcountries.eu/rest/v2".ToAbsoluteUrl().GetAsync<List<RestCountry>>();
usingRestClient.Net.Abstractions.Extensions;usingSystem.Collections.Generic;usingSystem.Threading.Tasks;usingUrls;namespaceRestClient.Net{publicstaticclassGitHubGraphQLMethods{publicstaticasyncTask<T>GetIssues<T>(stringrepo,stringaccessToken)=>(await"https://api.github.com/graphql".ToAbsoluteUrl().PostAsync<QueryResponse<T>,QueryRequest>(newQueryRequest("{ search(query:\"repo:"+repo+"\", type: ISSUE, first: 100) {nodes {... on Issue { number title body } } }}"),HeadersExtensions.FromBearerToken(accessToken).Append("User-Agent","RestClient.Net"))).Response.Body.data.search;}publicrecordQueryRequest(stringquery);publicrecordIssue(int?number,stringtitle,stringbody);publicrecordIssues(List<Issue>nodes);publicrecordData<T>(Tsearch);publicrecordQueryResponse<T>(Data<T>data);}
[<TestMethod>]memberthis.TestComposition()=leturi="host.com".ToHttpUrlFromHost(5000) .AddQueryParameter("fieldname1","field<>Value1") .WithCredentials("username","password") .AddQueryParameter("FieldName2","field<>Value2") .WithFragment("frag") .WithPath("pathpart1","pathpart2") Assert.AreEqual("http://username:password@host.com:5000/pathpart1/pathpart2?fieldname1=field%3C%3EValue1&FieldName2=field%3C%3EValue2#frag",uri.ToString());
About
.NET REST Client Framework for all platforms
Topics
Resources
License
Contributing
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Sponsor this project
Uh oh!
There was an error while loading.Please reload this page.
Packages0
Uh oh!
There was an error while loading.Please reload this page.
Contributors8
Uh oh!
There was an error while loading.Please reload this page.