Leaderboard API - build with Lumen PHP Framework

Use

GET: http://localhost/api/v1/lb/{leaderboard_name}
GET: http://localhost/api/v1/lb/{leaderboard_name}/{amt}

If {amt} is not defined, you'll receive all leaderboard items.

Example: http://localhost/api/v1/lb/tennis/1
Response (array of leaderboard items):  
[
  {
    "id":5,
    "leaderboard":"tennis",
    "name":"Daniel",
    "image":"images/1490066401_x1niktqy.png",
    "score":132,
    "rank":1,
    "created_at":"2017-03-21 03:20:01",
    "updated_at":"2017-03-21 03:20:01"
  }
]  

GET: http://localhost/api/v1/lb/{leaderboard_name}/with/{player_id}/{amt}

This returns {amt} of players in the leaderboard. If the {player_id} is not yet included it will be attached as an additional element at the end.

Example: http://localhost/api/v1/lb/tennis/with/2932/1
Response (array of leaderboard items):  
[
  {
    "id":5,
    "leaderboard":"tennis",
    "name":"Daniel",
    "image":"images/1490066401_x1niktqy.png",
    "score":132,
    "rank":1,
    "created_at":"2017-03-20 03:20:01",
    "updated_at":"2017-03-20 03:20:01"
  },
  {
    "id":2932,
    "leaderboard":"tennis",
    "name":"Frank P",
    "image":"images/1490066500_xDliktqy.png",
    "score":2,
    "rank":1289,
    "created_at":"2017-03-21 05:25:00",
    "updated_at":"2017-03-21 05:25:00"
  }
]  

GET: http://localhost/api/v1/p/{player_id}

Example: http://localhost/api/v1/p/6
Response:  
{
  "id":6,
  "leaderboard":"swimming",
  "name":"Daniel",
  "image":"images/1490066401_x1niktqy.png",
  "score":132,
  "rank":1,
  "created_at":"2017-03-20 03:20:01",
  "updated_at":"2017-03-20 03:20:01"
}

POST URL: http://localhost/api/v1/lb
POST DATA:
{
  "leaderboard": "tennis",    // required | string | min:3
  "name": "Daniel",           // required | string | min:2
  "score": 132,               // required | numeric
  "image": {attach image},    // optional
}

RESPONSE:  
{
  "id":5,
  "leaderboard":"tennis",
  "name":"Daniel",
  "image":"images/1490066401_x1niktqy.png",
  "score":132,
  "rank":1,
  "created_at":"2017-03-21 03:20:01",
  "updated_at":"2017-03-21 03:20:01"
}  

Loading images:

server + '/storage/' + image field from the api like:
http://localhost:8000/storage/images/1490066401_x1niktqy.png

Testing the api

To test the api, this is a pretty handy tool:
https://www.getpostman.com/

Installation

• This requires Php/Mysql environment (e.g. MAMP)
• Clone the repository
• Install composer
• run composer install
• set up mysql database and database user
• set up .env file

Create a symbolic link to be able to serve stored files:
On Mac OS X:
ln -s /path/to/laravel/storage/app/public /path/to/laravel/public/storage

If you are on windows you can run this command on cmd:
mklink /j /path/to/laravel/public/storage /path/to/laravel/storage/app/public

---

Official Lumen Documentation

Documentation for the framework can be found on the Lumen website.

Lumen License

The Lumen framework is open-sourced software licensed under the MIT license