HTTP API Documentation

[freezy 2]

I'm having a go at implementing a server plugin. My plugin talks to a REST API. Given there is IHttpClient and IJsonSerializer I thought this would be easy.

 

However, I can't find any documentation of any of those interfaces. IHttpClient can serialize response data from a stream into an object, so I would expect the same for the request data, i.e. posting data through the serializer.

 

But IHttpClient only seems to accept dictionaries as data for all Post overloads. Am I missing something? Do I really have to set property by property for every request? What if I have nested properties?

 

Also, I can't seem to find an actual implementation of IHttpClient. Given I have not found any documentation about the interface, this would be important for lots of reasons, namely to see how cookie handling works, but also redirection and other things.

 

Any links to documentation or source code of the above mentioned would be appreciated.

 

Cheers.

 

   -freezy.

[Luke 37068]

Hi, there's a method to set the post content as a string. just make sure to set the content type as well.

[freezy 2]

Which one? That's all I'm seeing:

Task<Stream> Post(string url, Dictionary<string, string> postData, SemaphoreSlim resourcePool, CancellationToken cancellationToken);
Task<Stream> Post(string url, Dictionary<string, string> postData, CancellationToken cancellationToken);
Task<Stream> Post(HttpRequestOptions options, Dictionary<string, string> postData);
Task<HttpResponseInfo> Post(HttpRequestOptions options);

I don't see anything data-related in HttpRequestOptions, and all the other overloads take in dictionaries. This is MediaBrowser.Common.Net.IHttpClient.

[Luke 37068]

There is a method on the HttpRequestOptions, and then you can use the lower level SendAsync method.

[freezy 2]

Ah right, there is string RequestContent in HttpRequestOptions. Could I also just use Post(HttpRequestOptions options) then?

[Luke 37068]

Yes.

[freezy 2]

Thanks!

 

So for the cookies I suppose that IHttpClient doesn't automatically persist cookies for a given domain and I'll need to set them for every request? If so, is there a way to easily cache them somewhere?

 

For the redirections similar question: If there is a HTTP 301/302 received, does IHttpClient automatically follow or do I need to do this manually?

[Luke 37068]

It is a wrapper over HttpWebRequest. I am not sure of the answers to those questions so you will probably need to research that. I am guessing the redirect will be followed though.

[freezy 2]

Alright, thanks Luke!