https://github.com/WichardRiezebos/devrant

Unofficial csharp-client for the public devRant API.
https://github.com/WichardRiezebos/devrant

api client csharp devrant fml public unofficial

Last synced: 3 months ago
JSON representation

Unofficial csharp-client for the public devRant API.

• Host: GitHub
• URL: https://github.com/WichardRiezebos/devrant
• Owner: WichardRiezebos
• License: apache-2.0
• Created: 2017-02-05T18:39:02.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-02-05T20:02:50.000Z (almost 8 years ago)
• Last Synced: 2024-06-29T12:02:11.466Z (4 months ago)
• Topics: api, client, csharp, devrant, fml, public, unofficial
• Language: C#
• Homepage: http://devrant.io
• Size: 57.6 KB
• Stars: 5
• Watchers: 3
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-devrant - devRant-C# - A C# wrapper for the devRant API (Uncategorized / Uncategorized)

README

        
# DevRant

[![Build status](https://ci.appveyor.com/api/projects/status/mecpjf5cwqpdgd67?svg=true)](https://ci.appveyor.com/project/WichardRiezebos/devrant) [![NuGet](https://buildstats.info/nuget/DevRant)](https://www.nuget.org/packages/DevRant/) [![Join the chat at https://gitter.im/devrant-csharp/Lobby](https://badges.gitter.im/devrant-csharp/Lobby.svg)](https://gitter.im/devrant-csharp/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

Unofficial **csharp-client** for the *public* [devRant](https://www.devrant.io/) API. 

*Based on: [danillouz/devrant](https://github.com/danillouz/devrant)*

![Cartoon 2](https://www.devrant.io/static/devrant/img/cartoon2.png)

## 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}/](https://devrant.io/api/users/404181?app=3) | [GetProfileAsync](#getprofileasync) | Gets the complete profile of a devRant user. |

| [/api/devrant/rants/](https://devrant.io/api/devrant/rants?app=3&sort=algo&limit=50&skip=0) | [GetRantsAsync](#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`.