ODataHttpClient

KO | EN

gitlite — search

#python #react #ai #go #golang #deep-learning #linux #docker #macos #nodejs #java #awesome #awesome-list #openai

ODataHttpClient

(★ 27)

The simplest implementation of OData client.

ODataHttpClient Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Test](https://github.com/iwate/ODataHttpClient/actions/workflows/test.yml/badge.svg)](https://github.com/iwate/ODataHttpClient/actions/workflows/test.yml)
[![codecov](https://codecov.io/gh/iwate/ODataHttpClient/branch/master/graph/badge.svg)](https://codecov.io/gh/iwate/ODataHttpClient)
[![NuGet version](https://badge.fury.io/nu/ODataHttpClient.svg)](https://badge.fury.io/nu/ODataHttpClient)

The simplest implementation of OData client.

## Install

$ dotnet add package ODataHttpClient
    PS> Install-Package  ODataHttpClient

## Restrictions

- Not support XML (JSON only)
- Not support Query Builder

## Usage

### Simple Request

var client = new HttpClient();
    var odata = new ODataClient(client);
    var request = Request.Get($"{endpoint}/Products?$count=true");
    var response = await odata.SendAsync(request);

if (response.Success) 
    {
        var total = response.ReadAs<int>("$['@odata.count']");
        var products = response.ReadAs<IEnumerable<Product>>("$.value");
    }

### Batch Request

var responses = await odata.SendAsync(batch);
    // You can also use BatchAsync. 
    // var responses = await odata.BatchAsync(batch);

if (responses.All(res => res.Success)) 
    {
        var id = response.First().ReadAs<int>("$.Id");
    }
### Parameterized Uri

var client = new HttpClient();
    var odata = new ODataClient(client);
    var request = Request.Get($"{endpoint}/Products?$filter=ReleaseDate ge @Date", new { Date = new DateTimeOffset(new DateTime(2000, 1, 1)) });
    var response = await odata.SendAsync(request);

if (response.Success) 
    {
        ...
    }

And you can use `@@` as escape for `@`.

### Set OData Element Type
In default, OData element type is not contained in payload. If you want add element type, you sould use `type` parameter of Request factory method.

Request.Post("...", payload, type: "ODataDemo.Product")

### Change OData Element Type Key
In default, OData element type key is `odata.type`. If you want change key to other, you should use `typeKey` parameter of Request factory method.

Request.Post("...", payload, type: "ODataDemo.Product", typeKey: "@odata.type")

### Use for OData v3(v2)
If you use for OData v3(v2), you have to change serializer and parametalizer.

#### 1. Global level settings

ODataClient.UseHistoricalGlobal();

#### 2. Client level settings
not yet. If you want, please create issue ticket.

## Credential

### Basic Auth

var odata = new ODataClient(client, "username", "password");

### Custom
You should modify default settings of client which be passed to ODataClient constructor or implemet `ICredentialBuilder`

public class CustomCredentialBuilder : ODataHttpClient.Credentials.ICredentialBuilder
    {
        public void Build(HttpClient client, HttpRequestMessage message)
        {
            // implement custom credential logic.
        }
    }

And pass the builder instance to 2nd parameter constructor.

var odata = new ODataClient(client, new CustomCredentialBuilder());
    
## Json Serializer Settings
In default, ODataHttpClient use general json format. 
If you change [OData V2 JSON Serialization Format](http://www.odata.org/documentation/odata-version-2-0/json-format/#PrimitiveTypes), can select a way of three.

### 1. Global level settings

ODataHttpClient.Serializers.JsonSerializer.Default = ODataHttpClient.Serializers.JsonSerializer.Historical;

### 2. Instance level settings

var odata = new ODataHttpClient(httpClient, ODataHttpClient.Serializers.JsonSerializer.Historical);
    var request = odata.RequestFacotry.Get("..."); // MUST use RequestFactory

### 3. Request level settings

var serializer = ODataHttpClient.Serializers.JsonSerializer.Historical;
    var request = Request.Get("...", serializer); // pass serializer
    var response = await odata.SendAsync(request);
    var data = response.ReadAs<dynamic>(serializer); // pass serializer

## NotFound(404)

In default, ODataHttpClient decide 404 response code of GET and HEAD request to success. If you change to error, can select a way of followings.

```
var request = Request.Get("...", acceptNotFound: false);
var response = await odata.SendAsync(request);
```

When a response code of other HTTP methods, like as POST,PUT,PATCH and DELETE, is 404, ODataHttpClient set `Response.Success` false.

ODataHttpClient

ODataHttpClient Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

ODataHttpClient

ODataHttpClient Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README