Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bugthesystem/httwrap
General purpose, simple but useful HttpClient wrapper for .NET & Xamarin/Mono
https://github.com/bugthesystem/httwrap
c-sharp http-client mono xamarin
Last synced: 2 months ago
JSON representation
General purpose, simple but useful HttpClient wrapper for .NET & Xamarin/Mono
- Host: GitHub
- URL: https://github.com/bugthesystem/httwrap
- Owner: bugthesystem
- License: mit
- Created: 2015-01-29T13:46:05.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2017-09-25T20:51:22.000Z (over 7 years ago)
- Last Synced: 2024-10-12T01:25:05.952Z (3 months ago)
- Topics: c-sharp, http-client, mono, xamarin
- Language: C#
- Homepage:
- Size: 891 KB
- Stars: 45
- Watchers: 10
- Forks: 11
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Httwrap
General purpose, simple but useful HttpClient wrapper for .NET & Xamarin/Mono
[](https://ci.appveyor.com/project/ziyasal/httwrap)[](https://coveralls.io/r/ziyasal/Httwrap)
## How to use
### Install
```cs
PM> Install-Package Httwrap
```
### Init
```csharp
IHttwrapConfiguration configuration = new HttwrapConfiguration("http://localhost:9000/");
IHttwrapClient _httwrap = new HttwrapClient(configuration);
```
### GET
#### Basic
```csharp
IHttwrapResponse response = await _httwrap.GetAsync("api/products/1");
Dump(response.Data);
Dump(response.StatusCode);
```
#### With QueryString
*_It supports `DataMember` and `IgnoreDataMember` attributes._*
```csharp
/*
public class FilterRequest
{
[DataMember(Name = "cat")]
public string Category { get; set; }
public int NumberOfItems { get; set; }
}
*/
var payload = new FilterRequest
{
Category = "Shoes",
NumberOfItems = 10
};
//Url: api/test?cat=Shoes&NumberOfItems=10
IHttwrapResponse> response =
await _client.GetAsync>("api/test", payload);
Dump(response.Data);
Dump(response.StatusCode);
```
#### Serialize response
```csharp
IHttwrapResponse response = await _httwrap.GetAsync("api/products");
List values = response.ResultAs>();
Dump(response.StatusCode);
/* ResultAs() extension method uses Newtonsoft.Json serializer by default.
To use your own serializer set JExtensions.Serializer = new YourCustomSerializerImpl();*/
```
### POST
```csharp
Product product = new Product{ Name= "Product A", Quantity = 3 };
IHttwrapResponse response = await _httwrap.PostAsync("api/products",product);
Dump(response.StatusCode);
```
### PUT
```csharp
Product product = new Product{ Name= "Product A", Quantity = 3 };
IHttwrapResponse response = await _httwrap.PutAsync("api/products/1",product);
Dump(response.StatusCode);
```
### PATCH
```csharp
Product product = new Product{ Name= "Product A", Quantity = 3};
IHttwrapResponse response = await _httwrap.PatchAsync("api/products/1",product);
Dump(response.StatusCode);
```
### DELETE
```csharp
IHttwrapResponse response = await _httwrap.DeleteAsync("api/products/1");
Dump(response.StatusCode);
```
### Error Handler
```csharp
IHttwrapResponse> response =
await _httwrap.GetAsync>("api/products", (statusCode, body) =>
{
_logger.Error("Body :{0}, StatusCode :{1}", body, statusCode);
});
```
### Auth
#### Basic Credentials
```csharp
IHttwrapConfiguration configuration = new HttwrapConfiguration("http://localhost:9000/")
{
Credentials = new BasicAuthCredentials("user", "s3cr3t")
};
IHttwrapClient _httwrap = new HttwrapClient(configuration);
```
#### OAuth Credentials
_**Use existing ```token```**_
```csharp
IHttwrapConfiguration configuration = new HttwrapConfiguration("http://localhost:9000/")
{
Credentials = new OAuthCredentials("token")
};
IHttwrapClient _httwrap = new HttwrapClient(configuration);
```
_**Use Username / password to get token from ```edpoint```**_
```csharp
IHttwrapConfiguration configuration = new HttwrapConfiguration("http://localhost:9000/")
{
Credentials = new OAuthCredentials("us3r", "p4ssw0rd", BaseAddress + "/token")
};
IHttwrapClient _httwrap = new HttwrapClient(configuration);
```
### Req/Res Interceptor
```csharp
public class DummyInterceptor : IHttpInterceptor
{
private readonly IHttwrapClient _client;
public void OnRequest(HttpRequestMessage request)
{
}
public void OnResponse(HttpRequestMessage request, HttpResponseMessage response)
{
response.StatusCode = HttpStatusCode.Accepted;
}
}
client.AddInterceptor(new DummyInterceptor());
```
## Bugs
If you encounter a bug, performance issue, or malfunction, please add an [Issue](https://github.com/ziyasal/Httwrap/issues) with steps on how to reproduce the problem.
## TODO
- Add more tests
- Add more documentation
## License
Code and documentation are available according to the *MIT* License (see [LICENSE](https://github.com/ziyasal/Httwrap/blob/master/LICENSE)).
@ziλasal