https://github.com/msx752/riotapicaller
[RiotCaller] League Of Legends API C# Portable Library- with different way
https://github.com/msx752/riotapicaller
Last synced: over 1 year ago
JSON representation
[RiotCaller] League Of Legends API C# Portable Library- with different way
- Host: GitHub
- URL: https://github.com/msx752/riotapicaller
- Owner: msx752
- License: mit
- Created: 2016-06-29T07:35:02.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2016-08-21T01:07:19.000Z (almost 10 years ago)
- Last Synced: 2025-03-19T13:11:18.855Z (over 1 year ago)
- Language: C#
- Homepage:
- Size: 1.42 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.nuget.org/packages/RiotCaller)
[](https://www.nuget.org/packages/RiotCaller)
[](https://github.com/MSAlih1/RiotApiCaller/blob/master/LICENSE)
# RiotCaller
Project for [Riot Games](https://developer.riotgames.com) API (League Of Legends game)
- generic class and method were used
- Ninject InSingletonScope was used
- Repository Pattern included (half)
- there is RiotCaller.Tests also there is ExampleProject in solution
## Usage
### defining riotgames api key
```c#
ApiService.ApiKey="RiotGames API Key" //for service
```
or
```c#
ApiService svc = new ApiService("[Riot API Key here]"); //classic defining
Ranked data = svc.Api.GetStatsRanked("[summonerId]", "[region]");
```
### using with Ninject
```c#
..
kernel.Bind().ToSelf().InSingletonScope().WithConstructorArgument("[Riot API Key here]");
..
```
## Examples
##### GetSummoner TYPE 1:
```c#
var summoner1 = LolApi.Api.GetSummoner("[summonerName]", [region]);
```
##### GetSummoner TYPE 2:
```c#
//you can use this method in your solution wherever you want
var summoner2 = new RiotApiCaller(suffix.summonerByname);
summoner2.AddParam(param.summonerNames, new List() { "[summonerName]" });
summoner2.AddParam(param.region, "[region]");
summoner2.CreateRequest();
```
##### GetStatsRanked TYPE 1:
```c#
var ranked1 = LolApi.Api.GetStatsRanked("[summonerId]", "[region]");
```
##### GetStatsRanked TYPE 2:
```c#
//you can use this method in your solution wherever you want
var ranked2 = new RiotApiCaller(suffix.statsRanked);
ranked2.AddParam(param.summonerId, "[summonerId]");
ranked2.AddParam(param.region, "[region]");
ranked2.AddParam(param.season, "[season]");
ranked2.CreateRequest();
```
##### GetStatsRanked TYPE 3:
```c#
var ranked3 = summoner1.GetStatsRanked();
```
##### GetStatsRanked TYPE 4:
```c#
Summoner summoner1 = LolApi.Api.GetSummoner("[summonerName]", "[region]");
var ranked4 = SummonerExtensions.GetStatsRanked(summoner1);
```
OR
```c#
var ranked4 = SummonerExtensions.GetStatsRanked(new Summoner() { Id = "[summonerId]" });
```
## Coding Introduce
> ##### Type:Enum suffix
>this struct helps for creating api url
>if you add new api method you must add new suffix
> ###### it has three attributes
> - ApiType Attribute
- (defining this apiurl is static OR is non-static, routing API SERVER URL)
> - apiVer Attribute
- (sometimes we need two keys, EXAMPLE: ( 'by-summoner/{summonerIds}' AND 'by-summoner/{summonerIds}/entry' )
AND both of them use GetSummoner() ,so apiVer reference to BASE API URL like 'Summoner'
> - Value Attribute
- this attribute separates and contains (suffix url) for each API
> ##### Type:Enum param
>this struct helps replace to suffix url parameters
>if you add new suffix, you must add its parameter to param enum (if it has not already)
>Example: add new suffix name TEST with value, non-static, base api is league
```c#
[ApiType(apiType.nonStatic)]
[apiVer(apiVer.league)]
[Value("by-summoner/{LeagueName}/entry?api_key={api_key}")]
TEST
```
>its parameter {LeagueName} if it has not in param which helps replace to suffix, you must add new value to param, like this 'LeagueName'
## Use Of Caching
every ApiEndPoints can use memorycaching. (default value:FALSE)
```c#
ApiService svc = new ApiService();
Summoner data = svc.Api.GetSummoner("[summonerId]", "[region]", true); // TRUE: method is caching
Ranked data = svc.Api.GetStatsRanked("[summonerId]", "[region]", null, true); //caching
Champions data = svc.staticApi.GetChampions("[region]", "[language]", champData.all, true);//caching
```
## Libraries used
-.NET MVC and dependency injection (not finished also half)
- [Ninject](https://github.com/ninject/Ninject)
- [MemoryCache](http://www.adamriddick.com/memorycache-memory-storage)
- [Json.NET](https://github.com/JamesNK/Newtonsoft.Json)
## Development
if you have good idea, you can create pull request
## License
This project is licensed under the [MIT license](LICENSE).
## Disclaimer
RiotCaller is not endorsed by Riot Games and does not reflect the views or opinions of Riot Games or anyone officially involved in producing or managing League of Legends. League of Legends and Riot Games are trademarks or registered trademarks of Riot Games , Inc. League of Legends © Riot Games, Inc.