Kunc.RiotGames.Api 0.13.0

Kunc.RiotGames.Api

How to Use

using Kunc.RiotGames.Api;
using Microsoft.Extensions.DependencyInjection;

var services = new ServiceCollection()
    .AddRiotGamesApi(c => c.ApiKey = "RGAPI-...")
    .BuildServiceProvider();
IRiotGamesApi api = services.GetRequiredService<IRiotGamesApi>();
// or
IRiotGamesApi api = RiotGamesApi.Create(c => c.ApiKey = "RGAPI-...");

var account = await api.RiotAccountV1.GetAccountByRiotIdAsync(Regions.EUROPE, "AoshiW#IRON");
Console.WriteLine($"Account: {account.GetRiotId()}");

var summoner = await api.LolSummonerV4.GetSummonerByPuuidAsync(Regions.EUN1, account.Puuid);
Console.WriteLine();
Console.WriteLine("Ranks:");
var entries = await api.LolLeagueV4.LeagueEntriesForSummonerAsync(Regions.EUN1, summoner.Puuid);
foreach (var entry in entries)
{
    Console.WriteLine($"{entry.QueueType}: {entry.ToRank()}");
}

Features

Rate limiting

The rate limiter is automatically set according to your api key.

Caching

The HybridCache is used as the caching provider, so by default it is only cached in memory, if you want an out-of-process cache, register IDistributedCache service to ServiceCollection. It's also disabled by default in this project, so you have to enable it first. (Why is it disabled? Short answer: there is no universal setting, so it is better to let everyone set it up themselves.)

How to enable caching:

1. Add some IDistributedCache service
2. you can enable it globally for all endpoints by setting DefaultCacheEntryOptions.
3. you can enable/modify it only for some endpoints using MethodCacheEntryOptions[] (per endpoint setting takes precedence over global)

// optionally adding some IDistributedCache .. for example Redis
Services.AddStackExchangeRedisCache(o => 
{
    o.Configuration = "connection string";
});

// configuration 
Services.AddRiotGamesApi(c =>
{
    c.ApiKey = "RGAPI-...";
    
    // global
    c.DefaultCacheEntryOptions = new HybridCacheEntryOptions() { ... };
    
    // per endpoint (the endpoint url is used as the key)
    c.MethodCacheEntryOptions["/riot/account/v1/accounts/by-riot-id/{gameName}/{tagLine}"] = new HybridCacheEntryOptions() { ... };
})

Other useful things

Customizing JSON deserialization

The library allows to access the JsonSerializerOptions instance which is used for deserializing JSON into a class. So if there is some problem with the deserialization (e.g.: the property is of type int but Riot returns a number in decimal format: 5.0), you can change it with:

Services.AddRiotGamesApi>(c =>
{
    c.ApiKey = "RGAPI-...";

    c.JsonSerializerOptions = new JsonSerializerOptions()
    {
        Converters = { new DoubleToIntConverter() }
    };
});

Disclaimer

Kunc.RiotGames.Api isn't endorsed by Riot Games and doesn't reflect the views or opinions of Riot Games or anyone officially involved in producing or managing Riot Games properties. Riot Games, and all associated properties are trademarks or registered trademarks of Riot Games, Inc.