Skip to content
Base class for a Windows Phone 8.1 XAML, Windows 8.1 and Windows 10 Universal REST service implementation
C#
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Kulman.WPA81.BaseRestService
.gitignore
CHANGELOG.md
Kulman.WPA81.BaseRestService.sln
LICENSE
README.md
appveyor.yml

README.md

Base REST service for Universal Apps

NuGet version Build status MIT licensed UWP ready WinRT ready WPA81 ready

Base class for a Windows Phone 8.1 (Silverlight), Windows Phone 8.1 XAML and Windows 8.1 REST service implementation. Also works fin in Windows 10 projects (UWP).

Installation

PM> Install-Package Kulman.WPA81.BaseRestService

Usage

Create your service class and inherit from BaseRestService. The minimum you need to do to make it work is to override the GetBaseUrl() method to set the base url for all the requests.

public class MyDataService: BaseRestService
{
    protected override string GetBaseUrl()
    {
        return "my base url";
    }
}

You can (but do not have to) also override the GetRequestHeaders() method to set the default request headers.

protected override Dictionary<string, string> GetRequestHeaders(string requestUrl)
{
    return new Dictionary<string, string>
    {
        { "Accept-Encoding", "gzip, deflate" },
        { "Accept", "application/json" },
    };
}

You can also override the CreateJsonSerializerSettings method with you need custom JSON deserialization settings.

Now you can use the following methods in your class:

Task<T> Get<T>(string url);
Task<T> Put<T>(string url, object request);
Task<T> Post<T>(string url, object request);
Task<T> Patch<T>(string url, object request);
Task Delete(string url);
Task<Dictionary<string, string>> Head(string url);

If you need to get the raw request, there are overloads returning HttpResponseMessage:

Task<HttpResponseMessage> Get(string url);
Task<HttpResponseMessage> Put(string url, object request);
Task<HttpResponseMessage> Post(string url, object request);
Task<HttpResponseMessage> Patch(string url, object request);

All the available methods have overloads accepting and CancellationToken.

Methods in your service may then look like this

public Task<List<Account>> GetAccounts()
{
    return Get<List<Account>>("/accounts");
}
 
public Task<Account> UpdateAccount(Account account)
{
    return Patch<Account>("/accounts",account);
}

For more information, see my blog post REST service base class for Windows Phone 8.1 XAML apps.

For changes, see the changelog.

You can’t perform that action at this time.