Skip to content

Home

Jump to bottom
Daniel Dolejška edited this page Jan 25, 2018 · 10 revisions

Version v2.0.0-rc.1

Build Status Test Coverage GitHub release GitHub pre release Packagist Packagist

Introduction

Welcome to Wiki for this repo!

The goal of this library is to create easy-to-use library for anyone who might need one. This is fully object oriented API wrapper for League of Legends' API. A small DataDragon API is also included.

Here are some handy features:

  • Rate limit caching and limit exceeding prevention - fully automatic.
  • Call caching - this enables the library to re-use already fetched data within short timespan - saving time and API rate limit.
  • StaticData linking - library can automatically link Static Data related to your request right into the returned object.
  • Custom callbacks - you can set custom function which will be called before or after the request is processed.
  • Object extensions - you can implement own methods to the fetched API objects itself and enable yourself to use them later to ease of your work.
  • Interim mode support, you are going to be able to use the API the same way whether your key is in interim mode or not (meaning you won't need to change anything when you jump to production).
  • CLI supported! You can use the library easily even in PHP CLI mode.
  • Objects everywhere! API calls return data in special objects.

I would be grateful for any feedback - so if you can give me any, just do it! Also feel free to send pull requests if you find anything that is worth improving!

Please, read on :)

Downloading

The easiest way to get this library is to use Composer. While having Composer installed it takes only composer require dolejska-daniel/riot-api to get the library ready!

If you are not fan of Composer, you can download whole repository in .zip archive or clone the repository using Git - git clone https://github.com/dolejska-daniel/riot-api. But in this case, you will have to create your own autoload function.

Clone this wiki locally