Skip to content

Latest commit

 

History

History
64 lines (46 loc) · 2 KB

README.md

File metadata and controls

64 lines (46 loc) · 2 KB

DevRant

Build status NuGet Join the chat at https://gitter.im/devrant-csharp/Lobby

Unofficial csharp-client for the public devRant API. Based on: danillouz/devrant

Cartoon 2

Prerequisites

  • .NET Framework 4.5

Installation

Install the NuGet package using the command below:

Install-Package DevRant

...or search for DevRant in the NuGet index.

Getting started

The code below is an example how to use the library.

using DevRant;
using DevRant.Dtos;
....
using(var devRant = new DevRantClient())
{
    var profile = await devRant.GetProfileAsync("WichardRiezebos");
	var topTenRants = await devRant.GetRantsAsync(sort: RantSort.Top, limit: 10);
}

Methods

All the available rest-api method(s) are described below:

API METHOD DESCRIPTION
/api/user/{id}/ GetProfileAsync Gets the complete profile of a devRant user.
/api/devrant/rants/ GetRantsAsync Gets a collection with rants.

GetProfileAsync

Arguments
NAME MANDATORY TYPE
username yes string

GetRantsAsync

Arguments
NAME MANDATORY TYPE DEFAULT
sort no enum (algo, recent and top) algo
limit no int 50
skip no int 0

Limitations

  • Not all methods are available yet.
  • Explicit use of Task Async.